Skip to content
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

Update release doc #2386

Merged
merged 1 commit into from
Aug 13, 2020
Merged

Update release doc #2386

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
43 changes: 41 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.
[Calendar Versioning](https://calver.org/) with GSA 20.8.

* Fetch upstream changes and create release branch

Expand All @@ -15,10 +15,20 @@ version number for the new release. We are following
and increment the version number and check PROJECT_BETA_RELEASE.
PROJECT_BETA_RELEASE must be unset for a non pre-release.

* Open [gsa/CMakeLists.txt](https://github.com/greenbone/gsa/blob/master/gsa/CMakeLists.txt)
and increment to the same version number.

* Open [gsad/CMakeLists.txt](https://github.com/greenbone/gsa/blob/master/gsad/CMakeLists.txt)
and increment to the same version number.

* Update version at the [package.json](https://github.com/greenbone/gsa/blob/master/gsa/package.json) file.

* Check version at the about page running GSA via gsad.

* Open [gsa/src/gmp/gmpsettings.js](https://github.com/greenbone/gsa/blob/master/gsa/src/gmp/gmpsettings.js)
and check the links for the manual (DEFAULT_MANUAL_URL and
DEFAULT_PROTOCOLDOC_URL variables).

* Test the build

```sh
Expand Down Expand Up @@ -49,7 +59,14 @@ version number for the new release. We are following
git tag -s v<version>
```

* Update version in [CMakeLists.tx](https://github.com/greenbone/gsa/blob/master/CMakeLists.txt)
* Update version in [CMakeLists.tx](https://github.com/greenbone/gsa/blob/master/CMakeLists.txt),
[gsa/CMakeLists.txt](https://github.com/greenbone/gsa/blob/master/gsa/CMakeLists.txt),
[gsad/CMakeLists.txt](https://github.com/greenbone/gsa/blob/master/gsad/CMakeLists.txt)
and [package.json](https://github.com/greenbone/gsa/blob/master/gsa/package.json)
files.

* Update [CHANGELOG.md](https://github.com/greenbone/gsa/blob/master/CHANGELOG.md)
with draft for next release.

* Create a commit

Expand All @@ -66,3 +83,25 @@ version number for the new release. We are following
* Create a Github release

See https://help.github.com/articles/creating-releases/

* Create node modules tarball

```sh
cd gsa
rm -rf node_modules
yarn install
tar cvzf gsa-node-modules-<version>.tar.gz node_modules
```

* Download release files from [GitHub release page](https://github.com/greenbone/gsa/releases)

* Create GPG signatures for release files

```sh
gpg --default-key 0ED1E580 --detach-sign --armor gsa-<version>.tar.gz
gpg --default-key 0ED1E580 --detach-sign --armor gsa-<version>.zip
gpg --default-key 0ED1E580 --detach-sign --armor gsa-note-modules-<version>.tar.gz
```

* Upload node modules tarball and signatures (.asc files) to the
[GitHub release page](https://github.com/greenbone/gsa/releases)