CID-1614: Automatic release notes, added pull request template #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mohamedlajmileanix
changed the title
VSM Github Broker Code Coverage
|
ahmed-ali-55
approved these changes
Oct 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes two enhancements to the repository's workflow:
New Pull Request Template.
The pull_request_template.md in the docs folder offers a structured and systematic way of recording changes made in PRs. This markdown file presents a list of possible changes, sections on the type of change, description of tests run, and a checklist for contributors to follow before submitting their PR. This will aid in providing more consistent and detailed PR reviews, hence improving collaboration.
Release Drafter
We will use Release Drafter to automate the creation of release notes (in a draft release). Once a PR is closed, Release Drafter automatically updates the release draft with details pulled from the PR.
The release-drafter.yml file, located in .github directory, holds the rules on how the release notes will be structured. Our configuration categorizes changes into features, bug fixes, and maintenance, each related to specific labels such as feature, fix, and chore respectively.
In addition, it determines the versioning rules: A 'major', 'minor', or 'patch' label attached to any PR will bump up the project's corresponding version.