Git Guard

GitGuard is an extension that contains a various set of tasks that can be used to verify certain git related contitions in pipelines
Explore the docs »

View Extension · Changelog · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Limitations
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Release and merge strategy
7. License
8. Contact

About The Project

An issue I often face is forgetting to update the state of a parent workitem when starting a new Task. This extension aims to auto update parent workitems based on a set of rules when the child workitem is started.

Getting Started

Prerequisites

• A MarketPlace publisher Create a publisher

• tfx-cli installed.

  npm install -g tfx-cli

• Pipelines uses the following extensions that needs to be installed in your organization in addition to default tasks:

  • GitGuard - Used to verify changes to files, such as changelog.
  • Azure DevOps Extension Tasks - Used to build and publish extension.

Installation

1. Clone the repo

   git clone https://github.com/joachimdalen/azdevops-git-guard.git

2. Install dependencies

   > npm install

3. Update publisher in vss-extension.dev.json

4. Compile development version

   npm run prepare:dev

5. Publish extension

6. Share and install extension

(back to top)

Usage

See documenation for usage.

(back to top)

Roadmap

See the open issues for a full list of proposed features.

(back to top)

Contributing

Contributions are welcome, both in the form of suggestions and code.

If you want to contribute code, I ask that you follow some guidelines.

• New and changed features should to the best ability be covered by tests
• Follow the branching policy:
  • feature/ for new features
  • bugfix/ for bug fixes
  • docs/ for documentation changes
• 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
• Pull requests should target the develop branch

1. Fork the Project
2. Create your Feature/Bugfix/Docs Branch (git checkout -b feature/1-some-change)
3. Commit your Changes (git commit -m 'Add some change')
4. Push to the Branch (git push origin feature/1-some-change)
5. Open a Pull Request

(back to top)

Release and merge strategy

• master is only deployed to PROD and tagged with v<extension_version>
  • Pull requests are always squash merged into master
  • master is the only branch where GitHub releases are created for
• feature/* and bugfix/* are deployed to DEV.

DEV is a private development environment (publications of the extensions.)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

If you have generic questions about the project or usage you can make contact in the following ways:

• Submit an issue with the @type/question label - New Issue
• Submit a new question under the Marketplace Q&A section.

(back to top)