Skip to content

Commit 9553b50

Browse files
committed
doc: add a small guide on how to release a new version to hex
1 parent 6017c68 commit 9553b50

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@ You can contribute to resvg_nif. Please check the [CONTRIBUTING.md](CONTRIBUTING
5151

5252
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to our [CODE_OF_CONDUCT.md](/CODE_OF_CONDUCT.md).
5353

54+
### How to release a new version to hex
55+
56+
1. Update the version in both `mix.exs` and `README.md`.
57+
2. Tag the commit with the version number, for example: `git tag v0.4.0 commit_hash`.
58+
3. Push the commit and the tag using: `git push origin master && git push --tags`.
59+
4. Wait for the CI to generate all the NIFs.
60+
5. Generate the NIF checksum with: `mix rustler_precompiled.download Resvg.Native --all`.
61+
6. Verify that the generated checksum is correct.
62+
7. Publish the package with: `mix hex.publish`.
63+
64+
Let me know if you'd like to adjust anything further!
5465
## Copyright and License
5566

5667
Copyright (c) 2023 Mrdotb

0 commit comments

Comments
 (0)