Skip to content
This repository was archived by the owner on Sep 11, 2023. It is now read-only.

Commit be5b34f

Browse files
committed
Init commit
0 parents  commit be5b34f

2 files changed

Lines changed: 170 additions & 0 deletions

File tree

README.md

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
<div id="top"></div>
2+
<!-- PROJECT LOGO -->
3+
<br />
4+
<div align="center">
5+
<a href="https://github.com/joachimdalen/azdevops-pull-request-utils">
6+
<img src="extension-icon.png" alt="Logo" width="100" height="100">
7+
</a>
8+
9+
<h3 align="center">Pull Request Utils</h3>
10+
11+
<p align="center">
12+
An extensions to manage pull requests. Includes posting comments on pull requests, checking if tags are assigned, assigning tags, updating the description and creating statuses
13+
<br />
14+
<a href="https://github.com/joachimdalen/azdevops-pull-request-utils/blob/master/docs/index.md"><strong>Explore the docs »</strong></a>
15+
<br />
16+
<br />
17+
<a href="https://marketplace.visualstudio.com/items?itemName=joachimdalen.pull-request-utils">View Extension</a>
18+
·
19+
<a href="https://github.com/joachimdalen/azdevops-pull-request-utils/blob/master/CHANGELOG.md">Changelog</a>
20+
·
21+
<a href="https://github.com/joachimdalen/azdevops-pull-request-utils/issues">Report Bug</a>
22+
·
23+
<a href="https://github.com/joachimdalen/azdevops-pull-request-utils/issues">Request Feature</a>
24+
</p>
25+
</div>
26+
27+
<div align="center">
28+
<img alt="Azure DevOps builds" src="https://img.shields.io/azure-devops/build/dalenapps/6531387f-baea-443c-a284-0d0e786e56c3/43?color=0078d7&label=Master%20Build&logo=azure-devops&style=flat-square">
29+
<img alt="Issues" src="https://img.shields.io/github/issues/joachimdalen/azdevops-pull-request-utils.svg?style=flat-square">
30+
<img alt="License" src="https://img.shields.io/github/license/joachimdalen/azdevops-pull-request-utils?style=flat-square">
31+
</div>
32+
<div align="center">
33+
34+
<img alt="Visual Studio Marketplace Installs - Azure DevOps Extension" src="https://img.shields.io/visual-studio-marketplace/azure-devops/installs/total/joachimdalen.pull-request-utils?label=Marketplace%20Installs&style=flat-square">
35+
<img alt="Visual Studio Marketplace Last Updated" src="https://img.shields.io/visual-studio-marketplace/last-updated/joachimdalen.pull-request-utils?style=flat-square">
36+
<img alt="Visual Studio Marketplace Rating" src="https://img.shields.io/visual-studio-marketplace/r/joachimdalen.pull-request-utils?style=flat-square">
37+
</div>
38+
39+
<!-- TABLE OF CONTENTS -->
40+
<details>
41+
<summary>Table of Contents</summary>
42+
<ol>
43+
<li>
44+
<a href="#getting-started">Getting Started</a>
45+
<ul>
46+
<li><a href="#prerequisites">Prerequisites</a></li>
47+
<li><a href="#installation">Installation</a></li>
48+
</ul>
49+
</li>
50+
<li><a href="#roadmap">Roadmap</a></li>
51+
<li><a href="#contributing">Contributing</a></li>
52+
<li><a href="#release-and-merge-strategy">Release and merge strategy</a></li>
53+
<li><a href="#license">License</a></li>
54+
<li><a href="#contact">Contact</a></li>
55+
</ol>
56+
</details>
57+
58+
<!-- ABOUT THE PROJECT -->
59+
60+
---
61+
62+
## Getting Started
63+
64+
### Prerequisites
65+
66+
- A MarketPlace publisher [Create a publisher](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#create-a-publisher)
67+
- `tfx-cli` installed. Due to issues with outdated dependencies this is not included in `package.json`
68+
69+
```sh
70+
npm install -g tfx-cli
71+
```
72+
73+
- Pipelines uses the following extensions that needs to be installed in your organization in addition to default tasks:
74+
- [GitGuard](https://marketplace.visualstudio.com/items?itemName=joachimdalen.gitguard) - Used to verify changes to files, such as changelog.
75+
- [Azure DevOps Extension Tasks](https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks) - Used to build and publish extension.
76+
77+
### Installation
78+
79+
1. Clone the repo
80+
81+
```sh
82+
git clone https://github.com/joachimdalen/azdevops-pull-request-utils.git
83+
```
84+
85+
2. Install dependencies
86+
87+
```sh
88+
> npm install
89+
```
90+
91+
3. Update publisher in `vss-extension-dev.json`
92+
4. Compile development version
93+
94+
```sh
95+
npm run prepare:dev
96+
```
97+
98+
5. [Publish extension](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#publish-an-extension)
99+
6. [Share](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#share-an-extension) and [install](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#install-an-extension) extension
100+
7. Run extension
101+
102+
```sh
103+
npm run serve:dev
104+
```
105+
106+
**Note:** You might need to open [https://localhost:3000/](https://localhost:3000/) in your browser from time to time to accept the unsecure certificate to have the extension load properly from your local environment.
107+
108+
<p align="right">(<a href="#top">back to top</a>)</p>
109+
110+
<!-- USAGE EXAMPLES -->
111+
112+
## Roadmap
113+
114+
See the [open issues](https://github.com/joachimdalen/azdevops-pull-request-utils/issues?q=is%3Aopen+is%3Aissue+label%3A%40type%2Ffeature) for a full list of proposed features.
115+
116+
<p align="right">(<a href="#top">back to top</a>)</p>
117+
118+
<!-- CONTRIBUTING -->
119+
120+
## Contributing
121+
122+
Contributions are welcome, both in the form of suggestions and code. Create
123+
124+
If you want to contribute code, I ask that you follow some guidelines.
125+
126+
- New and changed features should to the best ability be covered by tests
127+
- Follow the branching policy:
128+
- `feature/` for new features
129+
- `bugfix/` for bug fixes
130+
- `docs/` for documentation changes
131+
- If your change is related to an issue, use the id as the first part of the branch e.g `bugfix/12-fix-crash-when-updating-rule`
132+
- Pull requests should target the `develop` branch
133+
134+
1. Fork the Project
135+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
136+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
137+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
138+
5. Open a Pull Request
139+
140+
<p align="right">(<a href="#top">back to top</a>)</p>
141+
142+
## Release and merge strategy
143+
144+
- `master` is only deployed to `PROD` and tagged with `v<extension_version>`
145+
- Pull requests are always squash merged into `master`
146+
- `master` is the only branch where GitHub releases are created for
147+
- `feature/*` and `bugfix/*` are deployed to `QA`. For deployment to `DEV` using local assets (only manifest changes are deployed to dev), the `Deploy to DEV instead of QA` option needs to be checked when running the deployment pipeline.
148+
149+
`QA` and `DEV` are private development and verfication environments (publications of the extensions.) Submit a new issue if you for some reason wish access to either of these.
150+
151+
**Note** Access to these are not given for your local development. Please publish your own development release.
152+
153+
<!-- LICENSE -->
154+
155+
## License
156+
157+
Distributed under the MIT License. See `LICENSE` for more information.
158+
159+
<p align="right">(<a href="#top">back to top</a>)</p>
160+
161+
<!-- CONTACT -->
162+
163+
## Contact
164+
165+
If you have generic questions about the project or usage you can make contact in the following ways:
166+
167+
- Submit an issue with the `@type/question` label - [New Issue](https://github.com/joachimdalen/azdevops-pull-request-utils/issues/new)
168+
- Submit a new question under the [Marketplace Q&A section](https://marketplace.visualstudio.com/items?itemName=joachimdalen.pull-request-utils&ssr=false#qna).
169+
170+
<p align="right">(<a href="#top">back to top</a>)</p>

extension-icon.png

2.72 KB
Loading

0 commit comments

Comments
 (0)