ember-cli follows the same channel based release process that Ember does:
release- This branch represents thelatestdist-tag on NPMbeta- This branch represents thebetadist-tag on NPMmaster- The branch represents thealphadist-tag on NPM
Most changes should be made as a PR that targets the master branch and then makes their way through beta and release over the course of 12 weeks as part of the Ember release train. Generally speaking we do not backport functional changes to beta or release but we can if needs be.
This release process is managed by release-plan which means that all changes should be made as a pull request to make sure it is captured in the changelog.
During the release week each of the versions are effectively "promoted" i.e. the current beta version is released as latest, the current alpha version is released as beta and a new alpha version is created. This requires PRs to each of the active branches to update ember-source (and potentially ember-data) versions. Each of those PRs that update dependencies should be marked as enhancement if we are releasing a minor version.
The release process during release week should look like this:
- Make sure that
@ember/app-blueprintis released before starting any of these steps - Merge any outstanding
Prepare Alpha Releasebranches - Do an intial stable release from the
releasebranch - Merge
releaseintobeta - Do a
betarelease - Merge
betaintomaster - Do an
alpharelease
This makes sure that you are starting from a "clean slate" before doing any other releases. This will make each of the following steps easier to follow.
You can use this saved search to find any outstanding Prepare Release branches.
-
fetch latest from origin
git fetch -
create a new branch to do the release e.g.
git checkout --no-track -b release-plan-6-4 origin/release- note: branches named like
release-6-4are used to manage LTS patch releases so we don't want to create a branch with that name at this time
- note: branches named like
-
Merge
origin/betainto the release branchgit merge origin/beta --no-ff- make sure to not update the .release-plan file this should only ever be changed by the release-plan github scripts
- make sure to not update the .github/workflows/plan-stable-release.yml file this should still plan a stable release
- make sure to not update the .github/workflows/publish-stable.yml file this should still publish a stable release
- make sure to not update the CHANGELOG.md file so as not to include the beta or alpha changelogs in the next release
- make sure to not update the version in the package.json during this step, this will be release-plan's job
- make sure to not update the version in the
packages/app-blueprint/package.json, orpackages/addon-blueprint/package.jsonfiles during this step, this will be release-plan's job - make sure to not add the
release-planconfig section to the package.json during this step. We are releasing a real release so we don't want to configure release-plan to do a pre-release. - commit the merge
git commit -am "promote beta to release"
-
Update blueprint dependencies to latest. Note: ember-data needs to be updated only in the alpha version from now on, make sure to only update to the release version of what was in the beta.
node ./dev/update-blueprint-dependencies.js --ember-source=latest --ember-data=<whatever version was in the beta> -
run
pnpm lint:fix -
update the @ember/app-blueprint dependency
pnpm i -w @ember/app-blueprint@latest -
manually add a
~back into the@ember/app-blueprintdependency in the root package.json -
run
pnpm installto make sure the lock file is up to date -
commit this update
git commit -am "update blueprint dependencies to latest" -
push and open a PR targeting
releasewith a PR title likePromote Beta and update all dependencies for 6.4 release -
mark this PR as an
enhancementif it is a minor release -
check that everything is ok (i.e. that CI has run correctly and that you have the changes you expect)
-
merge branch
-
check that the
Prepare ReleasePR has been correctly opened byrelease-plan -
Merge the
Prepare Releasebranch when you are ready to release -
Check the
Release StableGitHub action to make sure the release succeeded
- Update the
@ember/app-blueprintreleasebranch to use this new version of ember-cli - continue the rest of the @ember/app-blueprint release process until beta and alpha are released
-
fetch latest from origin
git fetch -
create a new branch to merge
releaseintobetae.g.git checkout --no-track -b merge-release origin/beta -
merge release into this new branch e.g.
git merge origin/release --no-ff- make sure to not update the .release-plan file this should only ever be changed by the release-plan github scripts
- make sure to not update any .github/workflows/plan-beta-release.yml file this should still plan a beta release
- make sure to not update any .github/workflows/publish-beta.yml file this should still publish a beta release
- make sure to not update the version in the
package.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.jsonduring this step, that step comes later - make sure to not remove the
release-planconfig section to thepackage.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.json, during this step. - commit the merge
git commit -am "merge release into beta"
-
merge master into this new branch too e.g.
git merge origin/master --no-ff- make sure to not update the .release-plan file this should only ever be changed by the release-plan github scripts
- make sure to not update the CHANGELOG.md file in this step. It should match the changelog on
origin/releaseat this stage. - make sure not to update the
release-planconfig inpackage.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.json - make sure not to update the
@ember-tooling/blueprint-blueprintversions (i.e. not workspace dependencies) inpackage.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.json - make sure not to add any files from
packages/blueprint-blueprintorpackages/blueprint-modelin this merge (those files only exist on main) - commit the merge
git commit -am "merge master into beta"
-
update the versions in package.jsons
- update the alpha version in package.json to be a beta i.e. if the incoming merge is
"version": "6.6.0-alpha.3",update it to"version": "6.6.0-beta.0", - update the alpha version in
packages/addon-blueprint/package.jsonto be the same beta version - update the alpha version in
packages/app-blueprint/package.jsonto be the same beta version - update the
ember-clireference inpackages/app-blueprint/files/package.jsonto be the same as the version you just put in the top level package.json - commit the version changes
git commit -am "update versions"
- update the alpha version in package.json to be a beta i.e. if the incoming merge is
-
Update blueprint dependencies to beta
node ./dev/update-blueprint-dependencies.js --ember-source=beta --ember-data=<whatever version was in the alpha> -
run
pnpm lint:fix -
update the @ember/app-blueprint dependency
pnpm i -w @ember/app-blueprint@beta -
manually add a
~back into the@ember/app-blueprintdependency in the root package.json -
run
pnpm installto make sure the lock file is up to date -
commit this update
git commit -am "update blueprint dependencies to beta" -
push and open a PR targeting
betawith a PR title likePrepare 6.5-beta -
mark this PR as an
enchancementif the next beta is a minor release -
check that everything is ok i.e. CI passes
-
merge the
merge-releasebranch intobetain GitHub -
check that the
Prepare Beta ReleasePR has been correctly opened byrelease-plan- note: the release-plan config will automatically make this version a pre-release
-
Merge the
Prepare Beta Releasewhen you are ready to release the next beta version -
Check the
Release BetaGitHub action to make sure the release succeeded
-
fetch latest from origin
git fetch -
create a new branch to merge
betaintomastere.g.git checkout --no-track -b merge-beta origin/master -
merge beta into this new branch e.g.
git merge origin/beta --no-ff- make sure to not update the .release-plan file this should only ever be changed by the release-plan github scripts
- make sure to not update the version in the
package.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.jsonduring this step, that step comes later - make sure to not update the
release-planconfig section to thepackage.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.json, during this step. - make sure not to update the
@ember-tooling/blueprint-blueprintor@ember-tooling/blueprint-modelaway from beingworkspace: *dependencies inpackage.json,packages/addon-blueprint/package.json, orpackages/app-blueprint/package.json. On master they always use the latest and don't use semver. - make sure to not update any .github/workflows/plan-release.yml file this should still plan a beta release
- make sure to not update any .github/workflows/publish.yml file this should still publish a beta release
- make sure to not update the CHANGELOG.md file in this step.
- make sure not to delete any package files they exist on master but not on either the release or beta branches
- commit this merge
-
manually update the version in
package.jsonto be the next alpha.- e.g. if the current alpha is
"version": "6.6.0-alpha.3",update it to be"version": "6.7.0-alpha.0",
- e.g. if the current alpha is
-
manually update the alpha version in
packages/addon-blueprint/package.jsonto be the same alpha -
manually update the alpha version in
packages/app-blueprint/package.jsonto be the same alpha -
update the
ember-clireference inpackages/app-blueprint/files/package.jsonto be the same alpha -
commit this change
git commit -am "update to the next alpha version" -
Update blueprint dependencies to alpha
node ./dev/update-blueprint-dependencies.js --ember-source=alpha --ember-data=<whatever version is in the package.json> -
note: ember-data (aka warp-drive) should only ever be updated on master as a separate PR. It is no longer part of the release process
-
run
pnpm lint:fix -
update the @ember/app-blueprint dependency
pnpm i -w @ember/app-blueprint@alpha -
make sure the app-blueprint still has a
~after the above step -
run
pnpm installto make sure the lock file is up to date -
commit this update
git commit -am "update blueprint dependencies to alpha" -
push and open a PR targeting
masterwith a PR title likePrepare 6.6-alpha -
mark this PR as an
enchancementif the next alpha is a minor release -
check that everything is ok i.e. CI passes
-
merge the
merge-betabranch intomasterin GitHub -
check that the
Prepare Alpha ReleasePR has been correctly opened byrelease-plan -
Merge the
Prepare Alpha Releasewhen you are ready to release the next alpha version -
Check the
Release AlphaGitHub action to make sure the release succeeded
release-plan is designed to automatically generate a Changelog that includes the titles of every PR that was merged since the last release. As we would like to make use of this auto-generated Changelog we need to make sure that PRs are named correctly and the Changelog included in the "Prepare Release" PRs are what we were expecting.
If you want to change the content of the Changelog then you should update the PR titles you want to update and re-run the Prepare Release CI job for that branch. If there are PRs that you would prefer to exclude from the changelog (such as the merge-beta or merge-release PRs) then you can add the ignore label to the PR and they will be removed from the changelog.
Now that we're using release-plan for all releases, patch releases have become super easy! Every time you merge a PR to any branch that is being released with release-plan a new Prepare Release PR will be created. When you merge this Prepare Release branch it will automatically release the new Patch version.
There is a GitHub Actions workflow, https://github.com/ember-cli/ember-cli/actions/workflows/sync-output-repos.yml that pushes various invocations of the blueprint generator to "output repos". After release, make sure that all the jobs are "green" / succeeded.
What to check afterwards
- Apps: https://github.com/ember-cli/ember-app-output
- Addons: https://github.com/ember-cli/ember-addon-output
Both of these have a git-tag per release version
Multiple editors could be supported, but right now, we only "customize" for stackblitz.
https://github.com/ember-cli/editor-output/
- a branch for each scenario + release version
${editorName}-{addon,app}-output{-'typescript'?}{-version}- and the "latest release" (non beta) will not have a version at the end
- This includes [app, addon] X [javascript, typescript]
To make sure StackBlitz runs in their supported browsers (Chrome and FireFox, as of 2023-08-15)
- App + JS: https://stackblitz.com/github/ember-cli/editor-output/tree/stackblitz-app-output
- App + TS: https://stackblitz.com/github/ember-cli/editor-output/tree/stackblitz-app-output-typescript
- Addon + JS: https://stackblitz.com/github/ember-cli/editor-output/tree/stackblitz-addon-output
- Addon + TS: https://stackblitz.com/github/ember-cli/editor-output/tree/stackblitz-addon-output-typescript
The App + JS, and App + TS are linked from Stackblitz's frontend templates UI: https://stackblitz.com/?starters=frontend
if problems arise
Script for updating addon/app repos: https://github.com/ember-cli/ember-cli/blob/master/dev/update-output-repos.js Script for updating editors: https://github.com/ember-cli/ember-cli/blob/master/dev/update-editor-output-repos.js
Customizations on top of the default blueprint(s) are found here: https://github.com/ember-cli/ember-cli/tree/master/dev/online-editors/stackblitz The intent for these customizations is to either be very light, or not needed at all. If an online editor breaks with our default blueprint, then it's most likely that we have a bug (or something very goofy).