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

Setup release-plan and changelog

.github/workflows/plan-release.yml

@@ -0,0 +1,89 @@
+name: Release Plan Review
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+    types:
+      - labeled
+      - unlabeled
+
+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: 'main'
+      # 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
+      issues: read
+      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_target' && 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: 'main'
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - run: npm ci
+      - name: "Generate Explanation and Prep Changelogs"
+        id: explanation
+        run: |
+          set +e
+          npx 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 }}

.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: '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'
+    permissions:
+      contents: write
+      pull-requests: write
+
+    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'
+      - run: npm ci
+      - name: npm publish
+        run: npx release-plan publish
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,163 @@
+# Changelog
+
+## v1.3.4 (2022-10-22)
+
+#### :rocket: Enhancement
+* [#180](https://github.com/adopted-ember-addons/validated-changeset/pull/180) export array utils functions ([@AmauryD](https://github.com/AmauryD))
+
+#### Committers: 1
+- Amaury ([@AmauryD](https://github.com/AmauryD))
+
+
+## v1.3.3 (2022-08-07)
+
+#### :rocket: Enhancement
+* [#171](https://github.com/adopted-ember-addons/validated-changeset/pull/171) chore: import type ([@snewcomer](https://github.com/snewcomer))
+
+#### :bug: Bug Fix
+* [#176](https://github.com/adopted-ember-addons/validated-changeset/pull/176) fix rollbackInvalid removing valid changes ([@vstefanovic97](https://github.com/vstefanovic97))
+
+#### Committers: 2
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+- Vuk ([@vstefanovic97](https://github.com/vstefanovic97))
+
+
+## v1.3.2 (2022-04-17)
+
+#### :rocket: Enhancement
+* [#169](https://github.com/adopted-ember-addons/validated-changeset/pull/169) bugfix: execute does not work with new ValidatedChangeset ([@snewcomer](https://github.com/snewcomer))
+
+#### :bug: Bug Fix
+* [#169](https://github.com/adopted-ember-addons/validated-changeset/pull/169) bugfix: execute does not work with new ValidatedChangeset ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v1.3.0 (2022-04-13)
+
+#### :rocket: Enhancement
+* [#168](https://github.com/adopted-ember-addons/validated-changeset/pull/168) ValidationChangeset with external validation compatibility ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v1.1.3 (2022-02-14)
+
+#### :rocket: Enhancement
+* [#160](https://github.com/adopted-ember-addons/validated-changeset/pull/160) Fix restore method to work with nested keys ([@linainu](https://github.com/linainu))
+
+#### :bug: Bug Fix
+* [#160](https://github.com/adopted-ember-addons/validated-changeset/pull/160) Fix restore method to work with nested keys ([@linainu](https://github.com/linainu))
+
+#### Committers: 1
+- Polina ([@linainu](https://github.com/linainu))
+
+
+## v1.1.1 (2022-02-06)
+
+#### :rocket: Enhancement
+* [#153](https://github.com/adopted-ember-addons/validated-changeset/pull/153) Switch `master` -> `main` in GH actions config ([@SergeAstapov](https://github.com/SergeAstapov))
+
+#### :memo: Documentation
+* [#153](https://github.com/adopted-ember-addons/validated-changeset/pull/153) Switch `master` -> `main` in GH actions config ([@SergeAstapov](https://github.com/SergeAstapov))
+
+#### Committers: 2
+- Sergey Astapov ([@SergeAstapov](https://github.com/SergeAstapov))
+- achashchina ([@achashchina](https://github.com/achashchina))
+
+
+## v1.1.0 (2021-11-28)
+
+#### :rocket: Enhancement
+* [#143](https://github.com/adopted-ember-addons/validated-changeset/pull/143) target 2017 build ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.12 (2021-07-14)
+
+#### :bug: Bug Fix
+* [#133](https://github.com/adopted-ember-addons/validated-changeset/pull/133) Bugfix: validate on render without backtracking Ember assertion ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.11 (2021-07-08)
+
+#### :bug: Bug Fix
+* [#131](https://github.com/adopted-ember-addons/validated-changeset/pull/131) Fix Ember tracking issue on set ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.8 (2021-06-07)
+
+#### :bug: Bug Fix
+* [#125](https://github.com/adopted-ember-addons/validated-changeset/pull/125) [Bug] Same date comparision dirties changeset ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.6 (2021-05-21)
+
+#### :bug: Bug Fix
+* [#120](https://github.com/adopted-ember-addons/validated-changeset/pull/120) [Bug]: better support for ember-data objects ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.5 (2021-05-16)
+
+#### :bug: Bug Fix
+* [#119](https://github.com/adopted-ember-addons/validated-changeset/pull/119) [Bug]: setDeep does not respect re-setting top level Change object ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.4 (2021-05-09)
+
+#### :bug: Bug Fix
+* [#116](https://github.com/adopted-ember-addons/validated-changeset/pull/116) [Bugfix]: no underlying content path to key that was modified ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.14.0 (2021-02-25)
+
+#### :rocket: Enhancement
+* [#110](https://github.com/adopted-ember-addons/validated-changeset/pull/110) Refactor: no unwrap for arrays ([@snewcomer](https://github.com/snewcomer))
+* [#104](https://github.com/adopted-ember-addons/validated-changeset/pull/104) Implement support for Arrays ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+
+#### :bug: Bug Fix
+* [#107](https://github.com/adopted-ember-addons/validated-changeset/pull/107) [Bug]: Fix async validations ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 2
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+- [@NullVoxPopuli](https://github.com/NullVoxPopuli)
+
+
+## v0.13.1 (2021-02-03)
+
+#### :bug: Bug Fix
+* [#103](https://github.com/adopted-ember-addons/validated-changeset/pull/103) Missing isChange detection ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))
+
+
+## v0.13.0 (2021-02-03)
+
+#### :rocket: Enhancement
+* [#101](https://github.com/adopted-ember-addons/validated-changeset/pull/101) [Enhancement]: private change detection ([@snewcomer](https://github.com/snewcomer))
+
+#### Committers: 1
+- Scott Newcomer ([@snewcomer](https://github.com/snewcomer))

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