From 46db2e8f536f3b0a92c50ad815fe018a91945269 Mon Sep 17 00:00:00 2001 From: Pascal Wengerter Date: Wed, 28 Apr 2021 12:09:56 +0100 Subject: [PATCH] Reduce accounts&settings release guide to abstract asset generation command --- docs/extensions/accounts/releasing.md | 9 +-------- docs/extensions/settings/releasing.md | 9 +-------- docs/extensions/web/releasing.md | 2 +- 3 files changed, 3 insertions(+), 17 deletions(-) diff --git a/docs/extensions/accounts/releasing.md b/docs/extensions/accounts/releasing.md index 327dc53a8..374d77e6c 100644 --- a/docs/extensions/accounts/releasing.md +++ b/docs/extensions/accounts/releasing.md @@ -17,16 +17,9 @@ You need a working installation of [the Go programming language](https://golang. After adding changes to the accounts package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary. To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root -of the repository and then commit the resulting changes to your branch/PR. See below for a way to _only_ build the accounts extension assets. +of the repository and then commit the resulting changes to your branch/PR. ### Package Hierarchy - [ocis](https://github.com/owncloud/ocis) - [ocis-accounts](https://github.com/owncloud/ocis/tree/master/accounts) - -#### Updating ocis-accounts - -1. Make sure you are inside the [ocis repository](https://github.com/owncloud/ocis) and on your feature branch -2. Change into accounts' asset package folder via `cd accounts/pkg/assets` -3. Inside `accounts/pkg/assets`, run `go generate`. The output should look something like this: `accounts: embed.go - YYY/MM/DD ... to write [./embed.go] from config file ...` -4. Commit your changes, push them and [create a PR](https://github.com/owncloud/ocis/pulls) diff --git a/docs/extensions/settings/releasing.md b/docs/extensions/settings/releasing.md index 6e2cc4235..556ce9c2b 100644 --- a/docs/extensions/settings/releasing.md +++ b/docs/extensions/settings/releasing.md @@ -17,16 +17,9 @@ You need a working installation of [the Go programming language](https://golang. After adding changes to the settings package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary. To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root -of the repository and then commit the resulting changes to your branch/PR. See below for a way to _only_ build the settings extension assets. +of the repository and then commit the resulting changes to your branch/PR. ### Package Hierarchy - [ocis](https://github.com/owncloud/ocis) - [ocis-settings](https://github.com/owncloud/ocis/tree/master/settings) - -#### Updating ocis-settings - -1. Make sure you are inside the [ocis repository](https://github.com/owncloud/ocis) and on your feature branch -2. Change into settings' asset package folder via `cd settings/pkg/assets` -3. Inside `settings/pkg/assets`, run `go generate`. The output should look something like this: `settings: embed.go - YYY/MM/DD ... to write [./embed.go] from config file ...` -4. Commit your changes, push them and [create a PR](https://github.com/owncloud/ocis/pulls) diff --git a/docs/extensions/web/releasing.md b/docs/extensions/web/releasing.md index b1f6ea1a7..22a7a489b 100644 --- a/docs/extensions/web/releasing.md +++ b/docs/extensions/web/releasing.md @@ -16,7 +16,7 @@ To update this package within all the deliveries, we need to update the package ### Package Hierarchy -- [ocis](https://githug.com/owncloud/ocis) +- [ocis](https://github.com/owncloud/ocis) - [ocis-web](https://github.com/owncloud/ocis/tree/master/web) - [ocis-pkg](https://github.com/owncloud/ocis/tree/master/ocis-pkg) - [ownCloud Web](https://github.com/owncloud/web)