Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into test-triple-deep-v2-a…
Browse files Browse the repository at this point in the history
…ddon
  • Loading branch information
ef4 committed Sep 20, 2024
2 parents 8a807d4 + d82727f commit e4f9050
Show file tree
Hide file tree
Showing 59 changed files with 39,378 additions and 34,926 deletions.
37 changes: 10 additions & 27 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ jobs:
- uses: actions/checkout@v1
- uses: volta-cli/action@v4
with:
node-version: '14'
- uses: actions/cache@v2
node-version: '16'
- uses: actions/cache@v3
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -30,21 +30,23 @@ jobs:
run: for name in `ls packages/*/.eslintrc.js`; do dirname $name; done | xargs npx eslint --
- id: set-matrix
working-directory: test-scenarios
run: echo "::set-output name=matrix::$(npm run --silent test:list -- --matrix 'npm run test -- --filter %s:')"
run: |
matrix_json=$(node --require ts-node/register ./suite-setup-util.ts)
echo "matrix=$matrix_json" >> $GITHUB_OUTPUT
scenarios:
needs: discover_matrix
name: ${{ matrix.name }}
runs-on: ubuntu-latest
runs-on: '${{ matrix.os }}-latest'
strategy:
fail-fast: false
matrix: ${{fromJson(needs.discover_matrix.outputs.matrix)}}
steps:
- uses: actions/checkout@v1
- uses: volta-cli/action@v4
with:
node-version: '14'
- uses: actions/cache@v2
node-version: '16'
- uses: actions/cache@v3
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -62,8 +64,8 @@ jobs:
- uses: actions/checkout@v1
- uses: volta-cli/action@v4
with:
node-version: '14'
- uses: actions/cache@v2
node-version: '16'
- uses: actions/cache@v3
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -73,22 +75,3 @@ jobs:
- name: test
run: npm run test:node
working-directory: packages/ember-auto-import

ie:
name: ie11 safety
runs-on: windows-latest
steps:
- uses: actions/checkout@v1
- uses: volta-cli/action@v4
with:
node-version: '14'
- uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm install
- name: test
run: 'npm run test -- --filter browser-targets-transpiled:'
working-directory: test-scenarios
90 changes: 90 additions & 0 deletions .github/workflows/plan-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
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: 16

- 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 }}
57 changes: 57 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -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 }}
21 changes: 21 additions & 0 deletions .release-plan.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"solution": {
"ember-auto-import": {
"impact": "minor",
"oldVersion": "2.7.4",
"newVersion": "2.8.0",
"constraints": [
{
"impact": "minor",
"reason": "Appears in changelog section :rocket: Enhancement"
},
{
"impact": "patch",
"reason": "Appears in changelog section :house: Internal"
}
],
"pkgJSONPath": "./packages/ember-auto-import/package.json"
}
},
"description": "## Release (2024-09-16)\n\nember-auto-import 2.8.0 (minor)\n\n#### :rocket: Enhancement\n* `ember-auto-import`\n * [#623](https://github.com/embroider-build/ember-auto-import/pull/623) Optimize watched directories ([@simonihmig](https://github.com/simonihmig))\n\n#### :house: Internal\n* `ember-auto-import`\n * [#621](https://github.com/embroider-build/ember-auto-import/pull/621) fix the repo link in the published package ([@mansona](https://github.com/mansona))\n* Other\n * [#636](https://github.com/embroider-build/ember-auto-import/pull/636) update release-plan CI jobs ([@mansona](https://github.com/mansona))\n* `ember-auto-import`, `@ef4/test-scenarios`\n * [#634](https://github.com/embroider-build/ember-auto-import/pull/634) Update scenario-tester ([@simonihmig](https://github.com/simonihmig))\n * [#630](https://github.com/embroider-build/ember-auto-import/pull/630) Update TypeScript to latest ([@simonihmig](https://github.com/simonihmig))\n* `@ef4/addon-template`, `@ef4/app-template`, `@ef4/test-scenarios`\n * [#635](https://github.com/embroider-build/ember-auto-import/pull/635) Fix CI for new Ember v6 canary and volta v2 releases ([@simonihmig](https://github.com/simonihmig))\n\n#### Committers: 2\n- Chris Manson ([@mansona](https://github.com/mansona))\n- Simon Ihmig ([@simonihmig](https://github.com/simonihmig))\n"
}
27 changes: 27 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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/embroider-build/ember-auto-import/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
Loading

0 comments on commit e4f9050

Please sign in to comment.