Merge pull request #367 from mansona/release-plan

setup release-plan

.github/workflows/plan-release.yml

@@ -0,0 +1,62 @@
+name: Release Plan Review
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: 
+      - labeled
+
+concurrency:
+  group: plan-release-${{ github.head_ref || github.ref }}
+  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 }}
+
+    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: Release Preview
+          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@v3
+        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 }}

CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+8.0.0 / 2022-01-28
+==================
+  * Replace overridable icon paths with overridable icon components #324 from @pichfl
+  * BREAKING: Remove obsolete `equals` helper #326 from @pichfl
+  * Breaking: Drop support for Node 10 and Modernize syntax #320 from @pichfl
+  * add no-deprecations ember-try scenarios #322 from @mansona
+  * Fix `no-curly-component-invocation` issues #319 from @Turbo87
+  * update lint-to-the-future #318 from @mansona
+  * Fix `prettier` issues #315 from @Turbo87
+  * Fix `implicit-this` issues #314 from @Turbo87
+  * add fail-fast: false for ember-try scenarios #317 from @mansona
+
+7.0.0 / 2021-06-22
+==================
+
+  * Relax `ember-get-config` requirement to allow v0.3.x #312 from @Turbo87
+  * [BREAKING] Update ember using ember-cli-update and drop support for Node 8, Ember 2.18, and Ember 3.4 #308 from @mansona
+
+6.3.4 / 2021-03-23
+==================
+
+  * Move on-modifier from devDependencies to dependencies  #271 from @Shajansheriff
+  * Wraps dummy-application interactive config inputs in label tags #293 from @JamesS-M
+  * Use `this` in the template #305 from @pichfl
+  * Import `htmlSafe` from '@ember/template' rather than '@ember/string' #302 from @gilest
+
+6.3.3 / 2021-03-08
+==================
+
+  * Replace TravisCI with GitHub Actions #303 from @Turbo87
+
+6.3.2 / 2020-10-18
+==================
+
+  * fix: move auto-chagnelog to devDependencies
+  * README: Fix "Service Name" header syntax #294 from @Turbo87
+  * fix: avoid overriding globals.clearDuration when it's 0 #292 from @jacobq
+
+6.3.1 / 2020-09-28
+==================
+
+  * FIX: Merge pull request #287 from jacobq/remove-getWithDefault [`#286`](https://github.com/mansona/ember-cli-notifications/issues/286)
+
+6.3.0 / 2020-07-23
+==================
+
+  * services/notifications: Use new `content` array for each service instance #279 from @Turbo87
+  * Add configuration option to exclude all CSS #275 from @pichfl
+
+6.2.0 / 2020-02-11
+==================
+
+  * manually running postcss and adding it to vendor #262 from @mansona
+
+6.1.0 / 2020-02-15
+==================
+
+  * Fix mouseEnter/Leave deprecations #263 from @Shajansheriff
+
+6.0.0 / 2020-01-09
+==================
+
+  * remove support for Ember < 2.18
+  * fix issue with clicking close running onClick handler #259 from @mansona
+
+5.1.0 / 2020-01-09
+==================
+
+  * update dependencies with ember-cli-update from @mansona
+
+5.0.0 / 2020-01-09
+==================
+  * renaming service to simply 'notifications'
+  * Added support for SVG icons - and removing Font Awesome
+  * removing CSS Modules
+  * update with ember-cli-update
+
+5.0.0-2 / 2020-01-07
+==================
+
+  * Remove syntax error #258 from @cah-danmonroe
+
+5.0.0-0 / 2019-11-12
+==================
+
+  * renaming service to simply 'notifications'
+  * Added support for SVG icons - and removing Font Awesome
+  * removing CSS Modules
+  * update with ember-cli-update

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/mansona/ember-cli-notifications/pulls?q=is%3Apr+is%3Aopen+%22Plan+Release%22+in%3Atitle) PR

package.json

@@ -1,6 +1,9 @@
 {
   "private": true,
-  "repository": "",
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:mansona/ember-cli-notifications.git"
+  },
   "license": "MIT",
   "author": "",
   "scripts": {
@@ -18,7 +21,8 @@
   "devDependencies": {
     "concurrently": "^8.2.0",
     "prettier": "^3.0.3",
-    "prettier-plugin-ember-template-tag": "^1.1.0"
+    "prettier-plugin-ember-template-tag": "^1.1.0",
+    "release-plan": "^0.3.0"
   },
   "pnpm": {
     "overrides": {