From fdc8ee326a920583840f118331c3fb31f5288c7f Mon Sep 17 00:00:00 2001 From: Jannik Stehle <jannik.stehle@kiteworks.com> Date: Mon, 14 Oct 2024 16:38:11 +0200 Subject: [PATCH 1/2] chore: scripts for updating versions and creating tags Adds 2 scripts for updating versions and creating & pushing tags of the main app as well as all published packages. Also updates the dev docs. --- dev/scripts/bump_versions.sh | 29 +++++++++++++++++++++++++++++ dev/scripts/create_and_push_tags.sh | 26 ++++++++++++++++++++++++++ docs/releasing.md | 22 +++++++++++++--------- 3 files changed, 68 insertions(+), 9 deletions(-) create mode 100755 dev/scripts/bump_versions.sh create mode 100755 dev/scripts/create_and_push_tags.sh diff --git a/dev/scripts/bump_versions.sh b/dev/scripts/bump_versions.sh new file mode 100755 index 00000000000..519e0b64355 --- /dev/null +++ b/dev/scripts/bump_versions.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +# This script bumps the version in the package.json files of the main app +# and all published packages to the provided version. +# +# NOTE: only run this if all packages are supposed to get the same version! + +apps=("design-system" "eslint-config" "web-pkg" "web-client" "web-test-helpers") + +NEW_VERSION="$1" + +if [ -z "$NEW_VERSION" ]; then + echo "Error: No new version provided." + echo "Usage: $0 <new_version>" + exit 1 +fi + +cd "$(dirname "$0")/../.." +CURRENT_VERSION=$(node -p "require('./package.json').version") +sed -i '' "s/\"version\": \"${CURRENT_VERSION}\"/\"version\": \"${NEW_VERSION}\"/" package.json + +for app in "${apps[@]}"; do + cd "./packages/$app" + CURRENT_VERSION=$(node -p "require('./package.json').version") + sed -i '' "s/\"version\": \"${CURRENT_VERSION}\"/\"version\": \"${NEW_VERSION}\"/" package.json + cd "../.." +done + +echo "package.json files have been updated to version $NEW_VERSION" diff --git a/dev/scripts/create_and_push_tags.sh b/dev/scripts/create_and_push_tags.sh new file mode 100755 index 00000000000..3a2c7a9c82a --- /dev/null +++ b/dev/scripts/create_and_push_tags.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# This script creates and pushes tags for the main app and all published packages. + +APPS=("design-system" "eslint-config" "web-pkg" "web-client" "web-test-helpers") + +cd "$(dirname "$0")/../.." +VERSION=$(node -p "require('./package.json').version") +TAG="v${VERSION}" + +git tag "$TAG" +git push origin "$TAG" +echo "v$VERSION has been created and pushed" + +for app in "${APPS[@]}"; do + cd "./packages/$app" + + VERSION=$(node -p "require('./package.json').version") + TAG="${app}-v${VERSION}" + + git tag "$TAG" + git push origin "$TAG" + + echo "$app-v$VERSION has been created and pushed" + cd "../.." +done diff --git a/docs/releasing.md b/docs/releasing.md index ec87034f2c2..0017f6323e9 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -1,5 +1,5 @@ --- -title: "Releasing" +title: 'Releasing' weight: 25 geekdocRepo: https://github.com/owncloud/web geekdocEditPath: edit/master/docs @@ -10,7 +10,7 @@ geekdocFilePath: releasing.md ## Releasing ownCloud Web -OwnCloud Web can be hosted standalone, as part of oCIS or as ownCloud 10 app (Web UI versions < 7.1.0). +OwnCloud Web can be hosted standalone or as part of oCIS. ### Versioning @@ -23,15 +23,19 @@ The highest type before a new release determines the version update number, so i 1. Create a branch `release-$version` in <https://github.com/owncloud/web>. 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. Only Web UI versions < 7.1.0: Update the version in `packages/web-integration-oc10/appinfo/info.xml` -5. Update the version in `package.json` -6. Commit your changes. +4. Update the version in the following files (you can run `./dev/scripts/bump_versions.sh $version` if all get the same version): + - `package.json` + - `packages/design-system/package.json` + - `packages/eslint-config/package.json` + - `packages/web-pkg/package.json` + - `packages/web-client/package.json` + - `packages/web-test-helpers/package.json` +5. Commit and push your changes. +6. Run `./dev/scripts/create_and_push_tags.sh`. This script will create and push tags for the main app as well as all packages that need to be released. 7. After merging, wait for the CI to run on the merge commit. 8. Go to the [Releases section](https://github.com/owncloud/web/releases) and click "Draft a new Release". -9. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it. -10. The tag and the Release artifacts will be created automatically. +9. The release artifacts will be created automatically. ### Next steps -- The ownCloud 10 app gets created as part of the release pipeline and will be part of the [release assets](https://github.com/owncloud/web/releases). -- For oCIS the release assets need to be updated. For that we have prepared a [separate ocis-web release guide](https://owncloud.dev/extensions/web/releasing/). +For oCIS the release assets need to be updated. From b82e7bb64fd9b78af699d7e202d05b08a3929d4f Mon Sep 17 00:00:00 2001 From: Jannik Stehle <jannik.stehle@kiteworks.com> Date: Tue, 15 Oct 2024 07:50:50 +0200 Subject: [PATCH 2/2] docs: releasing docs improvements --- docs/releasing.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/releasing.md b/docs/releasing.md index 0017f6323e9..9ae5050c2ec 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -10,7 +10,7 @@ geekdocFilePath: releasing.md ## Releasing ownCloud Web -OwnCloud Web can be hosted standalone or as part of oCIS. +OwnCloud Web can be hosted standalone for a dedicated oCIS backend or bundled as part of oCIS. ### Versioning @@ -23,13 +23,7 @@ The highest type before a new release determines the version update number, so i 1. Create a branch `release-$version` in <https://github.com/owncloud/web>. 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 version in the following files (you can run `./dev/scripts/bump_versions.sh $version` if all get the same version): - - `package.json` - - `packages/design-system/package.json` - - `packages/eslint-config/package.json` - - `packages/web-pkg/package.json` - - `packages/web-client/package.json` - - `packages/web-test-helpers/package.json` +4. Run `./dev/scripts/bump_versions.sh $version`. This script will bump the `package.json` files in all relevant packages. 5. Commit and push your changes. 6. Run `./dev/scripts/create_and_push_tags.sh`. This script will create and push tags for the main app as well as all packages that need to be released. 7. After merging, wait for the CI to run on the merge commit. @@ -39,3 +33,5 @@ The highest type before a new release determines the version update number, so i ### Next steps For oCIS the release assets need to be updated. + +<!-- TODO: add reference to docs on how to update Web in oCIS -->