Skip to content

Commit a32f6f2

Browse files
committed
Add DEVELOPMENT.md
1 parent d1a9ab0 commit a32f6f2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

DEVELOPMENT.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Development Guide
2+
3+
## Release a new version
4+
5+
1. Run `FROM= TO= make version` to update all version numbers in the project.
6+
7+
- The `FROM` is the current version number, the `TO` is the new version number.
8+
- When you run the command, it will update the version number in the `Cargo.toml`, `package.json`, `gemspec` ...
9+
- Sometimes, this command may modify a wrong file, you need to `git diff` check the changed files and fix it manually.
10+
11+
1. Create a new tag with the new version number, e.g. `git tag v0.1.0`.
12+
1. Push the tag to the remote repository.
13+
1. Then the GitHub Actions will automatically build and publish the new version to the GitHub Package Registry.

0 commit comments

Comments
 (0)