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.

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

Add docs for releasing Phoenix assets #3186

Merged
merged 2 commits into from
Jul 13, 2020
Merged
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Releasing"
weight: 25
geekdocRepo: https://github.com/owncloud/phoenix
geekdocEditPath: edit/master/docs
geekdocFilePath: releasing.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.

This repository contains the assets and these must be released first before being bundled into `ocis-phoenix`.

### Package Hierarchy

- [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 <https://github.com/owncloud/phoenix>
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 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.

#### Next steps

The next steps are usually to update the Phoenix assets in the [ocis-phoenix](https://github.com/owncloud/ocis-phoenix) repository.