From 87f3960e917320bf6e7d06664a9b0093ec35fca5 Mon Sep 17 00:00:00 2001 From: Ricardo Mariano Date: Fri, 23 Jul 2021 10:32:52 +1000 Subject: [PATCH] Remove docs about automatic releases, remove release.yml (#1637) Follow-up from #1633. Other than the alpha-release job not working, internally the team maintaining misk and friends are revisiting the version update strategy for these repos, and think that using only manually cut releases is easier to reason about for downstream services. --- .github/workflows/release.yml | 57 ----------------------------------- RELEASING.md | 10 ++---- 2 files changed, 2 insertions(+), 65 deletions(-) delete mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index b39dbe7f61..0000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Alpha-Release - -# on: -# push: -# branches: -# - master - -jobs: - release: - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest] - node: [12] - - steps: - - uses: actions/checkout@v2 - - name: Install Misk-Web - run: sudo npm install -g @misk/cli - - name: Misk-Web Prebuild - run: miskweb prebuild -e - - name: Rush check for inconsistent dependency versions - run: node common/scripts/install-run-rush.js check - - name: Rush install - run: node common/scripts/install-run-rush.js update - - name: Rush build - run: node common/scripts/install-run-rush.js build --verbose - - name: Configure git user - uses: oleksiyrudenko/gha-git-credentials@v2.1 - with: - global: true - name: 'Misk-Web Alpha Release Bot' - email: 'misk-web+robots@squareup.com' - token: '${{ secrets.ACCESS_TOKEN }}' - - name: Rush bump version - run: node common/scripts/install-run-rush.js version --bump - - name: Rush publish - run: node common/scripts/install-run-rush.js publish --include-all -a -p -n ${NPM_PUBLISH_TOKEN} - env: - NPM_PUBLISH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} - - name: Install strip-json-comments-cli && jq - run: sudo npm install -g strip-json-comments-cli && sudo apt-get install jq - - name: Parse new version - run: NEW_VERSION=$(cat common/config/rush/version-policies.json | strip-json-comments | jq '.[0].version' | sed 's/"//g') && echo $NEW_VERSION >> NEW_VERSION - - name: Update Misk-Web versions and prebuild - run: miskweb pin $(cat NEW_VERSION) -e - - name: Update Rush lockfiles - run: node common/scripts/install-run-rush.js update - - name: Commit version changes - run: | - NEW_VERSION=$(cat NEW_VERSION) - rm NEW_VERSION - echo $NEW_VERSION - sudo git status - sudo git add . - sudo git commit -m "[ALPHA-RELEASE] ${NEW_VERSION}" - sudo git push origin diff --git a/RELEASING.md b/RELEASING.md index 2aba893d88..d865d49b64 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,13 +1,7 @@ -# Releasing `@Misk` Packages on NPM - -Alpha releases happen automatically after each merge to `master` branch. Check the commit history for commits by `Misk-Web Alpha Release Bot` for examples. - -Alphas releases are denoted by the trailing additional version added to the regular SemVer version of format `major.minor.patch-alpha`. For example, `0.1.25-5` is the `-5` alpha build of upcoming `0.1.25` stable release. - -As a result of Alpha releases happening automatically, any merged changes or bumped dependencies end up in usable, published NPM packages shortly after the PR being merged. To update tabs to latest alpha release, follow the linked steps to use [\$ miskweb pin](https://cashapp.github.io/misk-web/docs/guides/building-a-tab/08-upgrading-misk-web-version). - ## Manual Releasing `@Misk` Packages on NPM +To update tabs to latest alpha release, follow the linked steps to use [\$ miskweb pin](https://cashapp.github.io/misk-web/docs/guides/building-a-tab/08-upgrading-misk-web-version). + This outlines the steps necessary to manually release new `@misk` packages on NPM. ## NPM Setup