-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for making a release
- Loading branch information
1 parent
87e4cf6
commit 3a27538
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Release instructions | ||
|
||
Before creating a new release please do a careful consideration about the | ||
version number for the new release. We are following | ||
[Semantic Versioning](https://semver.org/) with GSA 8. | ||
|
||
* Fetch upstream changes and create release branch | ||
|
||
```sh | ||
git fetch upstream | ||
git checkout -b create-new-release upstream/master | ||
``` | ||
|
||
* Open [CMakeLists.tx](https://github.com/greenbone/gsa/blob/master/CMakeLists.txt) | ||
and increment the version number and check PROJECT_BETA_RELEASE. | ||
PROJECT_BETA_RELEASE must be unset for a non pre-release. | ||
|
||
* Test the build | ||
|
||
```sh | ||
mkdir build | ||
cd build | ||
cmake -DCMAKE_BUILD_TYPE=Release .. | ||
make -j6 | ||
``` | ||
|
||
* Update [CHANGES.md](https://github.com/greenbone/gsa/blob/master/CHANGES.md) | ||
|
||
* Create a git commit | ||
|
||
```sh | ||
git add . | ||
git commit -m "Prepare release <version>" | ||
``` | ||
|
||
* Create an annotated git tag | ||
|
||
```sh | ||
git tag -a v<version> | ||
``` | ||
|
||
or even better a signed tag with your gpg key | ||
|
||
```sh | ||
git tag -s v<version> | ||
``` | ||
|
||
* Update version in [CMakeLists.tx](https://github.com/greenbone/gsa/blob/master/CMakeLists.txt) | ||
|
||
* Create a commit | ||
|
||
```sh | ||
git commit -m "Update version after <version> release" | ||
``` | ||
|
||
* Push changes and tag to Github | ||
|
||
```sh | ||
git push --tags upstream master | ||
``` | ||
|
||
* Create a Github release | ||
|
||
See https://help.github.com/articles/creating-releases/ |