feat: clarify major release steps - #937
Open
utnapischtim wants to merge 1 commit into
Open
Conversation
ntarocco
reviewed
Jun 2, 2026
ntarocco
left a comment
ntarocco
left a comment
Contributor
There was a problem hiding this comment.
Thank you for clarifying all this. I have added a few comments to make sure that the text is well understood by everyone.
| [maintenance-policy](../../releases/maintenance-policy.md). The development is | ||
| done on betaXX.devXX tags on master. Since invenio-app-rdm represents the | ||
| product InvenioRDM it uses a slightly different versioning schema. It still | ||
| follows the semver rules of versioning, but not on he major versions but on the |
Contributor
There was a problem hiding this comment.
Suggested change
| follows the semver rules of versioning, but not on he major versions but on the | |
| follows the semver rules of versioning, but not on the major versions |
this sentence is difficult to understand with the double but, can you please rephrase it?
| product InvenioRDM it uses a slightly different versioning schema. It still | ||
| follows the semver rules of versioning, but not on he major versions but on the | ||
| beta versions. This means: releasing a new major version (e.g. v14.0) starts on | ||
| the master branch the tagging of beta versions (e.g. v15.0.0b0.dev0). The new |
Contributor
There was a problem hiding this comment.
What do you mean with the master branch the tagging of beta versions?
| ### Module releases | ||
|
|
||
| Doing a new major release of a module starts a major release chain. A module | ||
| supports only 1 major version of another module. This means doing a major break |
Contributor
There was a problem hiding this comment.
Suggested change
| supports only 1 major version of another module. This means doing a major break | |
| supports only 1 major version of another module. This means doing a major release |
| in a low level package as `invenio-db` starts a long major release chain up to | ||
| invenio-app-rdm. | ||
|
|
||
| TODO: picture of the graph? |
Contributor
There was a problem hiding this comment.
Not sure that a picture is needed here.
|
|
||
| ### Initial iteration | ||
| The product release cycle starts with the release of the major version. This | ||
| means that from the date of the major version the new development cycly starts. |
Contributor
There was a problem hiding this comment.
Suggested change
| means that from the date of the major version the new development cycly starts. | |
| means that from the date of the major version a new development cycle starts. |
| ### Initial iteration | ||
| The product release cycle starts with the release of the major version. This | ||
| means that from the date of the major version the new development cycly starts. | ||
| The release should take place in the first 2 weeks in July. The feature freeze |
Contributor
There was a problem hiding this comment.
Suggested change
| The release should take place in the first 2 weeks in July. The feature freeze | |
| A major release normally takes place in July. The features freeze |
Comment on lines
+74
to
+75
| in the first two weeks of June. The considering for feature freeze PR's deadline | ||
| takes place in the first weeks of April. |
Contributor
There was a problem hiding this comment.
The last sentence is not very clear to me. Could you please clarify what is happening n April?
Suggested change
| in the first two weeks of June. The considering for feature freeze PR's deadline | |
| takes place in the first weeks of April. | |
| in June. The considering for feature freeze PR's deadline takes place in the first weeks of April. |
Comment on lines
+87
to
+92
| The master branch will get a new major release. Yes it could be that the | ||
| master branch will get a major version without any real changes on the master | ||
| branch and therefor not follow semver in some points. But for the product | ||
| InvenioRDM and it's further development it is easier to do it that way. It | ||
| enables to merge breaking changes directly after the feature freeze and not | ||
| affecting the release of the product. |
Contributor
There was a problem hiding this comment.
Suggested change
| The master branch will get a new major release. Yes it could be that the | |
| master branch will get a major version without any real changes on the master | |
| branch and therefor not follow semver in some points. But for the product | |
| InvenioRDM and it's further development it is easier to do it that way. It | |
| enables to merge breaking changes directly after the feature freeze and not | |
| affecting the release of the product. | |
| The master branch will get a new major release, even without significant changes (in this case, semver is not strictly followed). This approach allows merging unrelated breaking changes after the features freeze, without affecting an ongoing release. |
Comment on lines
+164
to
+166
| Bugfixes and features are developed against the master branch and merged into | ||
| that branch first. Then the bugfix or feature is backported to the `maint-vX.Y` | ||
| branch. |
Contributor
There was a problem hiding this comment.
Suggested change
| Bugfixes and features are developed against the master branch and merged into | |
| that branch first. Then the bugfix or feature is backported to the `maint-vX.Y` | |
| branch. | |
| Bugfixes and features are developed from and merged into the master branch. Then, they are backported to the `maint-vX.Y` branch. |
fenekku
reviewed
Jun 22, 2026
fenekku
left a comment
fenekku
left a comment
Collaborator
There was a problem hiding this comment.
v14 cleanup
I think I understand what is described, but it is hard to parse in part because the original file is lacking a clearer cookbook/how-to style. By providing any information outside these steps as asides in info boxes, we can make this a more straightforward recipe with scattered explanations.
I don't consider this a blocker for v14 docs, so placing it aside for now.
Comment on lines
20
to
21
| - an instance template, [cookiecutter-invenio-rdm](https://github.com/inveniosoftware/cookiecutter-invenio-rdm) | ||
| - an application, [invenio-app-rdm](https://github.com/inveniosoftware/invenio-app-rdm) |
Collaborator
There was a problem hiding this comment.
Since the 2 are merged below, would merge here too:
Suggested change
| - an application: the combination of an instance template, [cookiecutter-invenio-rdm](https://github.com/inveniosoftware/cookiecutter-invenio-rdm) | |
| and the main module [invenio-app-rdm](https://github.com/inveniosoftware/invenio-app-rdm) collecting and configuring the others |
| cookiecutter-invenio-rdm. This branch is used when `invenio-cli init -c v14.0` | ||
| is used to init a new InvenioRDM instance) | ||
|
|
||
| A new major version of invenio-app-rdm is released once a year. see |
Collaborator
There was a problem hiding this comment.
Suggested change
| A new major version of invenio-app-rdm is released once a year. see | |
| A new major version of invenio-app-rdm is released once a year. See the |
| is used to init a new InvenioRDM instance) | ||
|
|
||
| A new major version of invenio-app-rdm is released once a year. see | ||
| [maintenance-policy](../../releases/maintenance-policy.md). The development is |
Collaborator
There was a problem hiding this comment.
Suggested change
| [maintenance-policy](../../releases/maintenance-policy.md). The development is | |
| [maintenance-policy](../../releases/maintenance-policy.md). Development is |
| A new major version of invenio-app-rdm is released once a year. see | ||
| [maintenance-policy](../../releases/maintenance-policy.md). The development is | ||
| done on betaXX.devXX tags on master. Since invenio-app-rdm represents the | ||
| product InvenioRDM it uses a slightly different versioning schema. It still |
Collaborator
There was a problem hiding this comment.
Suggested change
| product InvenioRDM it uses a slightly different versioning schema. It still | |
| product InvenioRDM it uses a slightly different versioning schema than other modules. It still |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.