Skip to content

Document scheduled actions updates for new releases #3656

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.

Sign up for GitHub

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

Merged
gerardsn merged 1 commit into from
Jan 13, 2025
Merged

Document scheduled actions updates for new releases #3656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 18 additions & 5 deletions docs/pages/development/2-releasing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
Releasing Nuts Node
###################

Nuts Node and auxiliary tools/applications follow a semantic versioning scheme (``<major>.<minor>.<patch>(-rc.<rc>)``):
Semantic versioning
*******************

Given a version number MAJOR.MINOR.PATCH, increment the:
Nuts Node and auxiliary tools/applications follow a semantic versioning scheme (``<major>.<minor>.<patch>(-rc.<rc>)``):

1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.
| Given a version number MAJOR.MINOR.PATCH, increment the:
|
| 1. MAJOR version when you make incompatible API changes,
| 2. MINOR version when you add functionality in a backwards compatible manner, or
| 3. PATCH version when you make backwards compatible bug fixes.

(Taken from `semver.org <https://semver.org/>`_)

Expand All @@ -24,6 +27,16 @@ This approach prevents the docker ``latest`` tags to be updated to a new version
Aside from the Nuts Node itself, all projects that follow the same versions need to be released.
They follow the major version from the Nuts Node, but minor and patch versions may differ.

Update automated tests
^^^^^^^^^^^^^^^^^^^^^^

Testing is automated using Github workflows.
Some of the tests cannot handle branch patterns and require each new major/minor version branch to be added to the workflow file manually.
The current list of files that need to be updated are:

- **Scheduled govulncheck** action: ``.github/workflows/govulncheck-cron-schedule.yaml``
- **Scheduled CodeQL** action: ``.github/workflows/codeql-analyisis-cron-schedule.yaml``

Major release
*************

Expand Down