Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update release process #1216

Merged
merged 1 commit into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed CHANGELOG.md
Empty file.
23 changes: 8 additions & 15 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
## Changelog

The changelog is a file that contains a curated, chronologically ordered list of
notable changes for each version of a project. It is a way to keep track of the
project's progress and to communicate the changes to the users and the
community. The changelog should be updated for each release and is part of the
release process.

Things to take into account while writing a changelog:
The changelog is a list of notable changes for each version of a project.
It is a way to keep track of the project's progress and to communicate
the changes to the users and the community.

The changelog is automatically generated on each release page, and extra contextual
information is added as needed, such as:
- General release information.
- Breaking changes.
- Notable changes.
Expand All @@ -21,18 +19,13 @@ version number, from the `main` branch. The release branch is used as a
breaking point and future reference for the release and should include the
changelog entries for the release and any other release-specific tasks. Any bug
fixes or changes for the release should be done on the release branch. When the
release branch is ready, create a Pull Request from release branch to the `main`
branch. Once the Pull Request is approved and merged, create a new tag for the
release branch and initiate any publishing tasks.
release branch is ready, create a new tag and initiate any publishing tasks.

Usually the release process is as follows:

1. Create a new release branch from the `main` branch.
2. Amend the changelog with the new release information.
3. Create a Pull Request with `main` branch as base.
4. Merge the Pull Request.
5. Create a new tag for the release branch.
6. Publish the release.
2. Create a new tag for the release branch.
3. Publish the release.

## Versioning

Expand Down
Loading