Introduce changelog process #61
Merged
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
KonradStaniec
requested review from
gitferry and
Lazar955
and removed request for
a team
RafilxTenfen
reviewed
Sep 9, 2024
RELEASE_PROCESS.md
Outdated
| * After final release is made e.g `v0.Y.0`, backport changelog changes to `main` branch | ||
| * checkout a new branch from the main branch: `username/backport_changelog` | ||
| * bring the new section from `release/v0.Y.x` branch to the `CHANGELOG.md` file on `main` branch | ||
| * open pr against the `main` branch |
There was a problem hiding this comment.
Suggested change
| * open pr against the `main` branch | |
| * open PR against the `main` branch |
maurolacy
approved these changes
Sep 9, 2024
There was a problem hiding this comment.
OK with me. This would require more manual work than with automated changelog generation, but the format and the content of the changelog file would be generally better (as long as the manual process is followed, of course).
As part of this, let's then remove the upate_changelog.sh script as well.
Lazar955
approved these changes
Sep 9, 2024
CONTRIBUTING.md
Outdated
| @@ -120,6 +121,25 @@ affect production code). | |||
| If you open a PR in Babylon, it is mandatory to update the relevant | |||
| documentation in `/docs`. | |||
|
|
|||
| ### Updating Changelog | |||
|
|
|||
| Any pr which is merged to `main` and affects consumers of the codebase, | |||
There was a problem hiding this comment.
Suggested change
| Any pr which is merged to `main` and affects consumers of the codebase, | |
| Any PR which is merged to `main` and affects consumers of the codebase, |
RELEASE_PROCESS.md
Outdated
| @@ -41,6 +41,9 @@ branch (see [CONTRIBUTING.md](./CONTRIBUTING.md#pull-requests)). | |||
| the minor version number, with patch part substituted to `x` (eg: v0.11.x). | |||
| * **PRs targeting directly a release branch can be merged _only_ when | |||
| exceptional circumstances arise**. | |||
| * In the release branch | |||
| * Create by a PR, new version section in the `CHANGELOG.md` matching the released version e.g | |||
There was a problem hiding this comment.
Suggested change
| * Create by a PR, new version section in the `CHANGELOG.md` matching the released version e.g | |
| * Created by a PR, a new version section in the `CHANGELOG.md` matching the released version e.g |
RELEASE_PROCESS.md
Outdated
| @@ -53,12 +56,19 @@ branch (see [CONTRIBUTING.md](./CONTRIBUTING.md#pull-requests)). | |||
| * The release verification on devnet must pass. | |||
| * When bugs are found, create a PR for `main`, and backport fixes to the | |||
| release branch. | |||
| * Before tagging release, create and merge pr to release branch that: | |||
There was a problem hiding this comment.
Suggested change
| * Before tagging release, create and merge pr to release branch that: | |
| * Before tagging the release, create and merge PR to the release branch that: |
gitferry
approved these changes
Sep 9, 2024
CONTRIBUTING.md
Outdated
| - adding new api | ||
| - adding new feature | ||
|
|
||
| Examples of changed that do not require changelog updates: |
There was a problem hiding this comment.
Suggested change
| Examples of changed that do not require changelog updates: | |
| Examples of changes that do not require changelog updates: |
CONTRIBUTING.md
Outdated
| - modifying documentation | ||
|
|
||
| The rule of thumb here it that changelog should be updated whenever change is | ||
| visible by external user. |
There was a problem hiding this comment.
Suggested change
| visible by external user. | |
| visible by external users. |
RELEASE_PROCESS.md
Outdated
| @@ -53,12 +56,19 @@ branch (see [CONTRIBUTING.md](./CONTRIBUTING.md#pull-requests)). | |||
| * The release verification on devnet must pass. | |||
| * When bugs are found, create a PR for `main`, and backport fixes to the | |||
| release branch. | |||
| * Before tagging release, create and merge pr to release branch that: | |||
| * Moves all changelog entries form `Unreleased` section of the changelog to newly created section `v0.Y.0` | |||
There was a problem hiding this comment.
Suggested change
| * Moves all changelog entries form `Unreleased` section of the changelog to newly created section `v0.Y.0` | |
| * Moves all changelog entries form `Unreleased` section of the changelog to the newly created section `v0.Y.0` |
RELEASE_PROCESS.md
Outdated
| * Create new release candidate tags after bugs are fixed. | ||
| * After the team feels the release candidate is ready, create a full release: | ||
| * **Note:** The final release MUST have the same commit hash as the latest | ||
| corresponding release candidate. | ||
| * Create a new annotated git tag in the release branch (follow the [Tagging | ||
| Procedure](#tagging-procedure)) | ||
| * After final release is made e.g `v0.Y.0`, backport changelog changes to `main` branch |
There was a problem hiding this comment.
Suggested change
| * After final release is made e.g `v0.Y.0`, backport changelog changes to `main` branch | |
| * After the final release is made e.g `v0.Y.0`, backport changelog changes to the `main` branch |
RELEASE_PROCESS.md
Outdated
| * checkout a new branch from the main branch: `username/backport_changelog` | ||
| * bring the new section from `release/v0.Y.x` branch to the `CHANGELOG.md` file on `main` branch | ||
| * open pr against the `main` branch | ||
|
|
CONTRIBUTING.md
Outdated
Comment on lines
131
to
133
| - bug fix | ||
| - adding new api | ||
| - adding new feature |
There was a problem hiding this comment.
Suggested change
| - bug fix | |
| - adding new api | |
| - adding new feature | |
| - bug fixes | |
| - adding new APIs | |
| - adding new features |
CONTRIBUTING.md
Outdated
| - adding new tests | ||
| - modifying documentation | ||
|
|
||
| The rule of thumb here it that changelog should be updated whenever change is |
There was a problem hiding this comment.
Suggested change
| The rule of thumb here it that changelog should be updated whenever change is | |
| The rule of thumb here is that the changelog should be updated as long as the is |
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.
CHANGELOG.mdfile to follow https://keepachangelog.com/en/1.0.0/ conventionCONTRIBUTING.mdandRELEASE_PROCESS.mdfiles