Skip to content

Commit 5f51247

Browse files
committed
docs(release): Add release process documentation
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
1 parent 20a6291 commit 5f51247

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

docs/Release.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Release
2+
3+
## How to release a new version for Yelix
4+
5+
1. **Create a new release branch**
6+
- Create a new branch from `main` with the version number, e.g.,
7+
`release/v1.0.0`.
8+
- Use the command: `git switch -c release/v1.0.0`.
9+
10+
2. **Update the version number**
11+
- Follow the semantic versioning rules.
12+
- Update the version number with `deno task bump:patch`,
13+
`deno task bump:minor`, or `deno task bump:major` as needed.
14+
- This will update the version in `deno.json`, `jsr.json` and `version.ts`
15+
files.
16+
17+
3. **Update the changelog**
18+
- Update the `CHANGELOG.md` file with the new version number and a summary of
19+
changes.
20+
21+
4. **Commit the changes**
22+
- Commit the changes with a message like `Release v1.0.0`.
23+
- Use the command: `git commit -m "Release v1.0.0"`.
24+
- Push the changes to the remote repository with
25+
`git push origin release/v1.0.0`.
26+
27+
5. **Create a pull request**
28+
- Create a pull request from the `release/v1.0.0` branch to the `main`
29+
branch.
30+
- Do not forget to add ChangeLog and version bump to the pull request
31+
description.
32+
- Add reviewers and assign the pull request to them.
33+
- Wait for the pull request to be reviewed and approved.
34+
- Once approved, merge the pull request into the `main` branch.
35+
36+
6. **Tag the release**
37+
- After merging the pull request, create a new tag for the release.
38+
- Use the command: `git tag v1.0.0`.
39+
- Push the tag to the remote repository with `git push origin v1.0.0`.
40+
41+
7. **Publish the release**
42+
- This will be done automatically by the CI/CD pipeline.
43+
- The pipeline will build the project and publish it to the Deno registry.
44+
- The release will be available at
45+
[jsr.io/@murat/yelix](https://jsr.io/@murat/yelix)

0 commit comments

Comments
 (0)