Skip to content

Commit

Permalink
Merge pull request avast#243 from avast/improve-deployment-docs
Browse files Browse the repository at this point in the history
docs: Improve release docs
  • Loading branch information
MatejKastak authored Mar 27, 2023
2 parents 29338ca + 611f083 commit 68d61c1
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/rtd/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Deployment
A new version of Yaramod is released performing the following steps:

* Open ``include/yaramod/yaramod.h`` and update ``YARAMOD_VERSION_PATCH`` (with big changes we also increment ``YARAMOD_VERSION_MINOR`` and set ``YARAMOD_VERSION_PATCH`` to 0).
* Open ``docs/rtd/conf.py`` and update version in ``release =``.
* In ``CHANGELOG.md`` add entry for the new version. List all important changes with links to issues and PRs.
* Commit the changes with message "Release v<?>.<?>.<?>".
* Create a git tag by running ``git tag -a v<?>.<?>.<?> -m "Release v<?>.<?>.<?>"``.
* Push the new tag with ``git push origin v<?>.<?>.<?>``.
* Push the commit after the release to master with ``git push origin master``.

0 comments on commit 68d61c1

Please sign in to comment.