Skip to content

Update maintainers guide #2144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update maintainers guide #2144

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01c36e2
Update maintainers guide
MinThaMie Sep 10, 2025
464a8a2
Update MAINTAINERS.md
MinThaMie Sep 10, 2025
c8a28e0
Update MAINTAINERS.md
MinThaMie Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ It is required that all maintainers use 2FA (two factor authentication). These a

#### Minor versions

To release a new minor version, you can use the `npm run release:guides:minor` command.
To release a new minor version, you can use the `pnpm run release:guides:minor` command.
The script will create and update the necessary files for you, showing you a URL at the end that you can use to create the PR.

0. Run `npm install` to guarantee dependencies are installed.
1. Run `npm run release:guides:minor`. The script is a mix of automated and manual steps, so follow the instructions carefully.
2. In the PR, mention that **the person who merges it must update the guides search ASAP**. Add a link to this page for instructions on updating the guides search. Look at the app in staging, get a review, and merge to `master`. This will trigger an auto deployment.
3. Once it is deployed, follow the steps below to get the website search working for your new version.
0. Run `pnpm install` to guarantee dependencies are installed.
1. Run `pnpm run release:guides:minor`. The script is a mix of automated and manual steps, so follow the instructions carefully.
1. This script will prompt you to pick the correct (remote) branch, make sure you pick the generated branch with the naming convention`create-new-guides-version-XXX`
3. In the PR, mention that **the person who merges it must update the guides search ASAP**. Add a link to this page for instructions on updating the guides search. Look at the app in staging, get a review, and merge to `master`. This will trigger an auto deployment.
4. Once it is deployed, follow the steps below to get the website search working for your new version.

#### Major versions

Expand All @@ -40,5 +41,5 @@ To make a major version release, please follow the steps in `scripts/create-new-

Currently getting the new version indexed and put in Algolia is a semi-manual step. There is currently work going on to try to make this automatic, see the [tracking issue here](https://github.com/ember-learn/guides-source/issues/487) to follow along with progress.

To proceed, run `npm run release:search` and you will be presented with instructions.
To proceed, run `pnpm run release:search` and you will be presented with instructions.
This will compile the search indices for the current release version and publish them to the Algolia instance.
Loading