From 940360c5e33852c7ccea4ab7886b8e583517298e Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Mon, 16 Mar 2020 17:39:42 +0100 Subject: [PATCH 1/2] Add docs for releasing --- docs/releasing.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/releasing.md diff --git a/docs/releasing.md b/docs/releasing.md new file mode 100644 index 00000000000..2e6496316c5 --- /dev/null +++ b/docs/releasing.md @@ -0,0 +1,52 @@ +--- +title: "Releasing Phoenix in oCIS" +weight: 25 +geekdocRepo: https://github.com/owncloud/phoenix +geekdocEditPath: edit/master/docs +geekdocFilePath: building.md +--- + +{{< toc >}} + +## Releasing Phoenix + +The next generation Web Frontend is shipped as an ocis Extension. The `ocis-phoenix` extension is also embedded in the single binary and part of the `ocis server` command. + +To update this package within all the deliveries, we need to update the package in the following chain from the bottom to the top. + +### Package Hierarchy + +```markdown +- [ ] [ocis](https://githug.com/owncloud/ocis) + - [ ] [ocis-phoenix](https://github.com/owncloud/ocis-phoenix) + - [ ] [ocis-pkg](https://github.com/owncloud/ocis-pkg) + - [ ] [phoenix](https://github.com/owncloud/phoenix) +``` + +#### Releasing Phoenix Frontend + +1. Create a branch `release-$version`. in +2. Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`. +3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. +4. Commit your changes. +5. After merging, wait for the CI to run on the merge commit. +6. Go to "Releases" in GH click "Draft a new Release". +7. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it. +8. The tag and the Release artifacts will be created automatically. + +#### Updating ocis-phoenix + +1. Create a branch `release-$version`. in +2. Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`. +3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. +4. Update the go module `ocis-pkg` to the latest version . +5. Update the phoenix asset in the Makefile. +6. Run `go generate`. +7. Create Changelog item for the Update in the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. +8. Commit your changes. +9. After merging, wait for the CI to run on the merge commit. +10. Go to "Releases" in GH click "Draft a new Release". +11. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it. +12. The tag and the Release artifacts will be created automatically. + +#### Updating the embedded ocis root command \ No newline at end of file From a0ccb3ca7262275b4f790d5239e1b57975e62f78 Mon Sep 17 00:00:00 2001 From: Vincent Petry Date: Fri, 10 Jul 2020 16:02:01 +0200 Subject: [PATCH 2/2] Reduce the release info to only Phoenix assets --- docs/releasing.md | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/docs/releasing.md b/docs/releasing.md index 2e6496316c5..a94962c94d1 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -1,9 +1,9 @@ --- -title: "Releasing Phoenix in oCIS" +title: "Releasing" weight: 25 geekdocRepo: https://github.com/owncloud/phoenix geekdocEditPath: edit/master/docs -geekdocFilePath: building.md +geekdocFilePath: releasing.md --- {{< toc >}} @@ -12,16 +12,14 @@ geekdocFilePath: building.md The next generation Web Frontend is shipped as an ocis Extension. The `ocis-phoenix` extension is also embedded in the single binary and part of the `ocis server` command. -To update this package within all the deliveries, we need to update the package in the following chain from the bottom to the top. +This repository contains the assets and these must be released first before being bundled into `ocis-phoenix`. ### Package Hierarchy -```markdown -- [ ] [ocis](https://githug.com/owncloud/ocis) - - [ ] [ocis-phoenix](https://github.com/owncloud/ocis-phoenix) - - [ ] [ocis-pkg](https://github.com/owncloud/ocis-pkg) - - [ ] [phoenix](https://github.com/owncloud/phoenix) -``` +- [ocis](https://githug.com/owncloud/ocis) + - [ocis-phoenix](https://github.com/owncloud/ocis-phoenix) + - [ocis-pkg](https://github.com/owncloud/ocis-pkg) + - [phoenix](https://github.com/owncloud/phoenix) #### Releasing Phoenix Frontend @@ -30,23 +28,11 @@ To update this package within all the deliveries, we need to update the package 3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. 4. Commit your changes. 5. After merging, wait for the CI to run on the merge commit. -6. Go to "Releases" in GH click "Draft a new Release". +6. Go to the [Releases section](https://github.com/owncloud/phoenix/releases) and click "Draft a new Release". 7. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it. 8. The tag and the Release artifacts will be created automatically. -#### Updating ocis-phoenix +#### Next steps + +The next steps are usually to update the Phoenix assets in the [ocis-phoenix](https://github.com/owncloud/ocis-phoenix) repository. -1. Create a branch `release-$version`. in -2. Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`. -3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. -4. Update the go module `ocis-pkg` to the latest version . -5. Update the phoenix asset in the Makefile. -6. Run `go generate`. -7. Create Changelog item for the Update in the `$major.$minor.$patchVersion_YYYY-MM-DD` folder. -8. Commit your changes. -9. After merging, wait for the CI to run on the merge commit. -10. Go to "Releases" in GH click "Draft a new Release". -11. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it. -12. The tag and the Release artifacts will be created automatically. - -#### Updating the embedded ocis root command \ No newline at end of file