Commit 8f4d68fa authored by Mathias Goebel's avatar Mathias Goebel 🎠
Browse files

Merge branch 'feature/release-documentation' into 'develop'

add release documentation to internal workflow section

See merge request !75
parents a3d99dff a241ee40
...@@ -110,6 +110,32 @@ After implementing (or declining) the desired suggestions, the MR is reassigned ...@@ -110,6 +110,32 @@ After implementing (or declining) the desired suggestions, the MR is reassigned
If a merge conflict occurs the person who has proposed the MR is responsible for solving all conflicts. If a merge conflict occurs the person who has proposed the MR is responsible for solving all conflicts.
### Release
New features and bugfixes will be added to new releases. [Here](https://gitlab.gwdg.de/SADE/SADE/-/releases)
you can find an overview of all releases.
#### How to set up a new release
Following the *git flow* new releases will be prepared with the CLI tool [gitflow-avh](https://github.com/petervanderdoes/gitflow-avh)).
+ the currently active [milestone](https://gitlab.gwdg.de/groups/SADE/-/milestones) names the version number of SADE/SADE only! For SADE/assets, SADE/build and all others please look at the version with `grep --max-count=1 project.version < build.properties`
* is there a sufficient number of issues closed?
* move open issues to next milestone
+ remove the [branch protection](https://gitlab.gwdg.de/SADE/SADE/-/settings/repository#js-protected-branches-settings) to enable push requests to develop and master (otherwise all merges have to be done at GitLab and not locally)
+ `git flow release start '[VERSION]'` to create the release branch.
+ set the version number according to the milestone
+ `git flow release finish '[VERSION]'` to merge the release branch into master and develop.
+ add Release Notes: The first commit message (`.git/MERGE_MSG`) the command above will ask for will become the release description.
* write in markdown and escape `#` with `\#`
* insert a headline and write a short paragraph about this release
* insert sections for features and bugfixes and list all of them using the issue reference `#[ISSUENUMBER]`
+ it is possible to use the same text for the following tag and commit message
+ after successfully finishing the release process, the version for develop should be increased by a PATCH ([SemVer](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions)). please commit this change.
+ send all of this to the remote `git push --all && git push --tags`
+ reset the [branch protection](https://gitlab.gwdg.de/SADE/SADE/-/settings/repository#js-protected-branches-settings)
#### GitLab Releases
GitLab can maintain releases via API only. Therefore a CI job is used parsing the
merge message, preserving the build artifact and preparing the release.
### Meetings ### Meetings
Once in a month all team members will meet at an informal (and usually internal) Once in a month all team members will meet at an informal (and usually internal)
meeting to discuss issues and proceedings. If external participants are interested meeting to discuss issues and proceedings. If external participants are interested
......
...@@ -18,6 +18,7 @@ ...@@ -18,6 +18,7 @@
<ul xmlns="http://www.w3.org/1999/xhtml"> <ul xmlns="http://www.w3.org/1999/xhtml">
<li class="feat">Features <li class="feat">Features
<ul> <ul>
<li>Add a documentation on release procedure</li>
<li>Add document how to use faceted search</li> <li>Add document how to use faceted search</li>
<li>Pretty print test results on command line</li> <li>Pretty print test results on command line</li>
<li>Server side pagination for search.html</li> <li>Server side pagination for search.html</li>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment