Merge pull request #404 from adopted-ember-addons/release-plan

NullVoxPopuli · web-flow · commit 9ac455beb10d · 2024-06-25T10:41:18.000-04:00
Setup release-plan
diff --git a/.github/workflows/plan-release.yml b/.github/workflows/plan-release.yml
@@ -0,0 +1,87 @@
+name: Release Plan Review
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    types:
+      - labeled
+
+concurrency:
+  group: plan-release # only the latest one of these should ever be running
+  cancel-in-progress: true
+
+jobs:
+  check-plan:
+    name: "Check Release Plan"
+    runs-on: ubuntu-latest
+    outputs:
+      command: ${{ steps.check-release.outputs.command }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: 'master'
+      # This will only cause the `check-plan` job to have a "command" of `release`
+      # when the .release-plan.json file was changed on the last commit.
+      - id: check-release
+        run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
+
+  prepare_release_notes:
+    name: Prepare Release Notes
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: check-plan
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      explanation: ${{ steps.explanation.outputs.text }}
+    # only run on push event if plan wasn't updated (don't create a release plan when we're releasing)
+    # only run on labeled event if the PR has already been merged
+    if: (github.event_name == 'push' && needs.check-plan.outputs.command != 'release') || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
+
+    steps:
+      - uses: actions/checkout@v4
+        # We need to download lots of history so that
+        # github-changelog can discover what's changed since the last release
+        with:
+          fetch-depth: 0
+          ref: 'master'
+      - uses: wyvox/action-setup-pnpm@v3
+
+      - name: "Generate Explanation and Prep Changelogs"
+        id: explanation
+        run: |
+          set +e
+
+          pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)
+
+
+          if [ $? -ne 0 ]; then
+            echo 'text<<EOF' >> $GITHUB_OUTPUT
+            cat release-plan-stderr.txt >> $GITHUB_OUTPUT
+            echo 'EOF' >> $GITHUB_OUTPUT
+          else
+            echo 'text<<EOF' >> $GITHUB_OUTPUT
+            jq .description .release-plan.json -r >> $GITHUB_OUTPUT
+            echo 'EOF' >> $GITHUB_OUTPUT
+            rm release-plan-stderr.txt
+          fi
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: "Prepare Release using 'release-plan'"
+          labels: "internal"
+          branch: release-preview
+          title: Prepare Release
+          body: |
+            This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍
+
+            -----------------------------------------
+
+            ${{ steps.explanation.outputs.text }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,57 @@
+# For every push to the master branch, this checks if the release-plan was
+# updated and if it was it will publish stable npm packages based on the
+# release plan
+
+name: Publish Stable
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+
+concurrency:
+  group: publish-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-plan:
+    name: "Check Release Plan"
+    runs-on: ubuntu-latest
+    outputs:
+      command: ${{ steps.check-release.outputs.command }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: 'master'
+      # This will only cause the `check-plan` job to have a result of `success`
+      # when the .release-plan.json file was changed on the last commit. This
+      # plus the fact that this action only runs on main will be enough of a guard
+      - id: check-release
+        run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT
+
+  publish:
+    name: "NPM Publish"
+    runs-on: ubuntu-latest
+    needs: check-plan
+    if: needs.check-plan.outputs.command == 'release'
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wyvox/action-setup-pnpm@v3
+        with:
+          # This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
+          node-registry-url: 'https://registry.npmjs.org'
+
+      - name: npm publish
+        run: pnpm release-plan publish
+
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+# Changelog
+
 ### 10.0.0
 
  * [BREAKING] This addon no longer provides the `moment` library itself. Apps should depend directly on *either* `moment` or `moment-timezone` and import it via `ember-auto-import`. Apps should make sure to remove any dependencies on `ember-cli-moment-shim`. See "Using Moment in Ember Apps & Addons" in the README.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,27 @@
+# Release Process
+
+Releases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.
+
+## Preparation
+
+Since the majority of the actual release process is automated, the remaining tasks before releasing are: 
+
+-  correctly labeling **all** pull requests that have been merged since the last release
+-  updating pull request titles so they make sense to our users
+
+Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
+guiding principle here is that changelogs are for humans, not machines.
+
+When reviewing merged PR's the labels to be used are:
+
+* breaking - Used when the PR is considered a breaking change.
+* enhancement - Used when the PR adds a new feature or enhancement.
+* bug - Used when the PR fixes a bug included in a previous release.
+* documentation - Used when the PR adds or updates documentation.
+* internal - Internal changes or things that don't fit in any other category.
+
+**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`
+
+## Release
+
+Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/adopted-ember-addons/ember-moment/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "moment",
     "momentjs"
   ],
+  "repository": "https://github.com/adopted-ember-addons/ember-moment.git",
   "license": "MIT",
   "author": "",
   "exports": {
@@ -18,7 +19,6 @@
     "addon-main.js",
     "dist"
   ],
-  "repository": "https://github.com/adopted-ember-addons/ember-moment.git",
   "scripts": {
     "clean": "rm -rf dist node_modules test-app/node_modules",
     "lint": "npm-run-all --aggregate-output --continue-on-error --parallel lint:*",
@@ -44,8 +44,8 @@
   "devDependencies": {
     "@babel/core": "^7.16.7",
     "@ember/optional-features": "^2.0.0",
-    "@ember/test-helpers": "^2.6.0",
     "@ember/string": "^3.1.1",
+    "@ember/test-helpers": "^2.6.0",
     "@embroider/addon-dev": "^0.50.2",
     "@embroider/compat": "npm:@embroider/compat@latest",
     "@embroider/core": "npm:@embroider/core@latest",
@@ -56,6 +56,7 @@
     "@rollup/plugin-babel": "^5.3.0",
     "babel-eslint": "^10.1.0",
     "ember-auto-import": "^2.3.0",
+    "ember-cli": "~3.28.5",
     "ember-cli-3.16": "npm:ember-cli@~3.16.0",
     "ember-cli-3.20": "npm:ember-cli@~3.20.0",
     "ember-cli-3.24": "npm:ember-cli@~3.24.0",
@@ -66,38 +67,38 @@
     "ember-cli-latest": "npm:ember-cli@latest",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-terser": "^4.0.2",
-    "ember-cli": "~3.28.5",
     "ember-disable-prototype-extensions": "^1.1.3",
     "ember-export-application-global": "^2.0.1",
     "ember-load-initializers": "^2.1.2",
     "ember-maybe-import-regenerator": "0.1.6",
     "ember-page-title": "^7.0.0",
     "ember-qunit": "^5.1.5",
     "ember-resolver": "^8.0.3",
+    "ember-source": "~3.28.8",
     "ember-source-3.16": "npm:ember-source@~3.16.0",
     "ember-source-3.20": "npm:ember-source@~3.20.0",
     "ember-source-3.24": "npm:ember-source@~3.24.0",
     "ember-source-beta": "npm:ember-source@beta",
     "ember-source-canary": "npm:ember-source@alpha",
     "ember-source-channel-url": "^3.0.0",
     "ember-source-latest": "npm:ember-source@latest",
-    "ember-source": "~3.28.8",
     "ember-template-lint": "^3.15.0",
     "ember-try": "^1.4.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-ember": "^10.5.8",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.1",
     "eslint-plugin-qunit": "^6.2.0",
-    "eslint": "^7.32.0",
     "jquery": "^3.6.0",
     "loader.js": "^4.7.0",
     "moment-timezone": "^0.5.33",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.5.1",
+    "qunit": "^2.17.2",
     "qunit-console-grouper": "^0.3.0",
     "qunit-dom": "^1.6.0",
-    "qunit": "^2.17.2",
+    "release-plan": "^0.9.0",
     "rollup": "^2.63.0",
     "scenario-tester": "^2.0.1",
     "webpack": "^5.65.0"
@@ -114,9 +115,14 @@
       "optional": true
     }
   },
+  "packageManager": "pnpm@9.4.0",
   "engines": {
     "node": ">= 18"
   },
+  "volta": {
+    "node": "18.20.3",
+    "pnpm": "9.4.0"
+  },
   "ember-addon": {
     "version": 2,
     "type": "addon",
@@ -146,10 +152,5 @@
       "./helpers/utc.js": "./dist/_app_/helpers/utc.js",
       "./services/moment.js": "./dist/_app_/services/moment.js"
     }
-  },
-  "volta": {
-    "node": "18.20.3",
-    "pnpm": "9.4.0"
-  },
-  "packageManager": "pnpm@9.4.0"
+  }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Changelog`
	`2`	`+`
`1`	`3`	`### 10.0.0`
`2`	`4`
`3`	`5`	* [BREAKING] This addon no longer provides the `moment` library itself. Apps should depend directly on either `moment` or `moment-timezone` and import it via `ember-auto-import`. Apps should make sure to remove any dependencies on `ember-cli-moment-shim`. See "Using Moment in Ember Apps & Addons" in the README.