From a7bd4d27eaa09b42b5a337f9019e96a3ab536e29 Mon Sep 17 00:00:00 2001 From: David Christofas Date: Wed, 20 May 2020 10:44:33 +0200 Subject: [PATCH] add documentation about the releasing process --- docs/grpc.md | 2 +- docs/license.md | 2 +- docs/releasing.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ templates/grpc.tmpl | 2 +- 4 files changed, 47 insertions(+), 3 deletions(-) create mode 100644 docs/releasing.md diff --git a/docs/grpc.md b/docs/grpc.md index a4b8e2f9d9..27d9c2376c 100644 --- a/docs/grpc.md +++ b/docs/grpc.md @@ -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 diff --git a/docs/license.md b/docs/license.md index 273e92c3b0..8a930291c9 100644 --- a/docs/license.md +++ b/docs/license.md @@ -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 diff --git a/docs/releasing.md b/docs/releasing.md new file mode 100644 index 0000000000..3ee9155b94 --- /dev/null +++ b/docs/releasing.md @@ -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! diff --git a/templates/grpc.tmpl b/templates/grpc.tmpl index d7c9da3e5d..545ab202de 100644 --- a/templates/grpc.tmpl +++ b/templates/grpc.tmpl @@ -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