Merge pull request #3 from ef4/release-plan

running npm init release-plan-setup

.github/workflows/plan-release.yml

@@ -0,0 +1,64 @@
+name: Release Plan Review
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: 
+      - labeled
+
+concurrency:
+  group: plan-release # only the latest one of these should ever be running
+  cancel-in-progress: true
+
+jobs:
+  prepare_release_notes:
+    name: Prepare Release Notes
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      explanation: ${{ steps.explanation.outputs.text }}
+    # only run on labeled event if the PR has already been merged
+    if: github.event_name == 'push' || (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
+        # lerna-changelog can discover what's changed since the last release
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - run: pnpm install --frozen-lockfile
+
+      - name: "Generate Explanation and Prep Changelogs"
+        id: explanation
+        run: |
+          set -x
+          
+          pnpm release-plan prepare
+          
+          echo 'text<<EOF' >> $GITHUB_OUTPUT
+          jq .description .release-plan.json -r >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: peter-evans/create-pull-request@v5
+        with:
+          commit-message: "Prepare Release using 'release-plan'"
+          author: "github-actions[bot] <[email protected]>"
+          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 }}

.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+# 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: 'main'
+      # 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'
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          # This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
+          registry-url: 'https://registry.npmjs.org'
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - run: pnpm install --frozen-lockfile
+      - name: npm publish
+        run: pnpm release-plan publish
+
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

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 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/ef4/lerna-changelog/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

package.json

@@ -10,16 +10,16 @@
   "bugs": {
     "url": "https://github.com/ef4/lerna-changelog/issues"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ef4/lerna-changelog.git"
+  },
   "license": "MIT",
   "author": "Bo Borgerson <[email protected]>",
   "main": "index.js",
   "bin": {
     "lerna-changelog": "bin/cli.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ef4/lerna-changelog.git"
-  },
   "scripts": {
     "build": "yarn clean && tsc",
     "changelog": "node ./bin/cli.js",
@@ -33,6 +33,34 @@
     "test-ci": "yarn build && yarn test",
     "watch": "yarn build -- --watch"
   },
+  "prettier": {
+    "arrowParens": "avoid",
+    "printWidth": 120,
+    "singleQuote": false,
+    "tabWidth": 2,
+    "trailingComma": "es5"
+  },
+  "jest": {
+    "projects": [
+      {
+        "displayName": "test",
+        "roots": [
+          "src"
+        ],
+        "preset": "ts-jest"
+      },
+      {
+        "displayName": "lint",
+        "runner": "jest-runner-eslint",
+        "moduleFileExtensions": [
+          "ts"
+        ],
+        "testMatch": [
+          "<rootDir>/src/**/*.ts"
+        ]
+      }
+    ]
+  },
   "dependencies": {
     "chalk": "^4.0.0",
     "cli-highlight": "^2.1.11",
@@ -57,6 +85,7 @@
     "prettier": "2.8.8",
     "release-it": "17.0.0",
     "release-it-lerna-changelog": "5.0.0",
+    "release-plan": "^0.3.0",
     "rimraf": "3.0.2",
     "ts-jest": "29.1.1",
     "typescript": "5.0.4"
@@ -74,33 +103,5 @@
       "internal": ":house: Internal"
     },
     "cacheDir": ".changelog"
-  },
-  "jest": {
-    "projects": [
-      {
-        "displayName": "test",
-        "roots": [
-          "src"
-        ],
-        "preset": "ts-jest"
-      },
-      {
-        "displayName": "lint",
-        "runner": "jest-runner-eslint",
-        "moduleFileExtensions": [
-          "ts"
-        ],
-        "testMatch": [
-          "<rootDir>/src/**/*.ts"
-        ]
-      }
-    ]
-  },
-  "prettier": {
-    "arrowParens": "avoid",
-    "printWidth": 120,
-    "tabWidth": 2,
-    "singleQuote": false,
-    "trailingComma": "es5"
   }
 }