add documentation about the releasing process

This commit is contained in:
David Christofas
2020-05-20 10:44:33 +02:00
parent 7867c53890
commit a7bd4d27ea
4 changed files with 47 additions and 3 deletions

View File

@@ -1,7 +1,7 @@
---
title: "GRPC API"
date: 2018-05-02T00:00:00+00:00
weight: 40
weight: 50
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
geekdocEditPath: edit/master/docs
geekdocFilePath: grpc.md

View File

@@ -1,7 +1,7 @@
---
title: "License"
date: 2018-05-02T00:00:00+00:00
weight: 50
weight: 60
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
geekdocEditPath: edit/master/docs
geekdocFilePath: license.md

44
docs/releasing.md Normal file
View File

@@ -0,0 +1,44 @@
---
title: "Releasing"
date: 2018-05-02T00:00:00+00:00
weight: 40
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
geekdocEditPath: edit/master/docs
geekdocFilePath: releasing.md
---
{{< toc >}}
To release a new version of ocis-thumbnails, you have to follow a few simple steps.
## Preperation
1. Create a new branch e.g. `prepare-release-x.x.x` where `x.x.x` is the version you want to release.
2. Checkout the preparation branch.
3. Create a new changelog folder and move the unreleased snippets there.
{{< highlight txt >}}
mkdir changelog/x.x.x_yyyy-MM-dd/ # yyyy-MM-dd is the current date
mv changelog/unreleased/* changelog/x.x.x_yyyy-MM-dd/
{{< / highlight >}}
4. Commit and push the changes
{{< highlight txt >}}
git add --all
git commit -m "prepare release x.x.x"
git push
{{< / highlight >}}
5. Create a pull request to the master branch.
## Release
1. After the preparation branch has been merged update your local master.
{{< highlight txt >}}
git checkout master
git pull
{{< / highlight >}}
2. Create a new tag (preferably signed).
{{< highlight txt >}}
git tag -s vx.x.x -m "release vx.x.x"
git push --tags
{{< / highlight >}}
Congratulations, you just released ocis-thumbnails!

View File

@@ -1,7 +1,7 @@
---
title: "GRPC API"
date: 2018-05-02T00:00:00+00:00
weight: 40
weight: 50
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
geekdocEditPath: edit/master/docs
geekdocFilePath: grpc.md