Skip to content

Commit

Permalink
chore: Rename to stable
Browse files Browse the repository at this point in the history
  • Loading branch information
danjm committed Nov 29, 2024
1 parent 5a20bac commit 79be051
Show file tree
Hide file tree
Showing 16 changed files with 57 additions and 57 deletions.
40 changes: 20 additions & 20 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ rc_branch_only: &rc_branch_only
only:
- /^Version-v(\d+)[.](\d+)[.](\d+)/

main_master_rc_only: &main_master_rc_only
main_stable_rc_only: &main_stable_rc_only
filters:
branches:
only:
- main
- master
- stable
- /^Version-v(\d+)[.](\d+)[.](\d+)/

aliases:
Expand Down Expand Up @@ -122,7 +122,7 @@ workflows:
filters:
branches:
ignore:
- master
- stable
- test-deps-audit:
requires:
- prep-deps
Expand Down Expand Up @@ -172,7 +172,7 @@ workflows:
requires:
- prep-deps
- prep-build-test-flask-mv2:
<<: *main_master_rc_only
<<: *main_stable_rc_only
requires:
- prep-deps
- prep-build-test-mmi:
Expand Down Expand Up @@ -200,7 +200,7 @@ workflows:
requires:
- prep-deps
- test-e2e-chrome-webpack:
<<: *main_master_rc_only
<<: *main_stable_rc_only
requires:
- prep-build-test-webpack
- get-changed-files-with-git-diff
Expand All @@ -209,7 +209,7 @@ workflows:
- prep-build-test
- get-changed-files-with-git-diff
- test-e2e-firefox:
<<: *main_master_rc_only
<<: *main_stable_rc_only
requires:
- prep-build-test-mv2
- get-changed-files-with-git-diff
Expand All @@ -229,7 +229,7 @@ workflows:
- prep-build-test-flask
- get-changed-files-with-git-diff
- test-e2e-firefox-flask:
<<: *main_master_rc_only
<<: *main_stable_rc_only
requires:
- prep-build-test-flask-mv2
- test-e2e-chrome-mmi:
Expand Down Expand Up @@ -337,7 +337,7 @@ workflows:
- job-publish-release:
filters:
branches:
only: master
only: stable
requires:
- prep-deps
- prep-build
Expand Down Expand Up @@ -403,7 +403,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down Expand Up @@ -477,7 +477,7 @@ jobs:

# This job is used for the e2e quality gate.
# It must be run before any job which uses the run-all.js script.
# The job is skipped in main, master or RC branches.
# The job is skipped in main, stable or RC branches.
get-changed-files-with-git-diff:
executor: node-browsers-small
steps:
Expand Down Expand Up @@ -558,7 +558,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand All @@ -567,7 +567,7 @@ jobs:
- when:
condition:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down Expand Up @@ -595,7 +595,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand All @@ -604,7 +604,7 @@ jobs:
- when:
condition:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down Expand Up @@ -638,7 +638,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand All @@ -647,7 +647,7 @@ jobs:
- when:
condition:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down Expand Up @@ -682,7 +682,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand All @@ -691,7 +691,7 @@ jobs:
- when:
condition:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down Expand Up @@ -723,7 +723,7 @@ jobs:
condition:
not:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand All @@ -732,7 +732,7 @@ jobs:
- when:
condition:
matches:
pattern: /^master$/
pattern: /^stable$/
value: << pipeline.git.branch >>
steps:
- run:
Expand Down
2 changes: 1 addition & 1 deletion .circleci/scripts/check_mmi_trigger.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ if [ -z "$CIRCLE_PULL_REQUEST" ] || [ -z "$GITHUB_TOKEN" ]; then
exit 0
fi

if [[ $CIRCLE_BRANCH = 'main' || $CIRCLE_BRANCH = 'master' || $CIRCLE_BRANCH =~ ^Version-v[0-9.]* ]]; then
if [[ $CIRCLE_BRANCH = 'main' || $CIRCLE_BRANCH = 'stable' || $CIRCLE_BRANCH =~ ^Version-v[0-9.]* ]]; then
echo "Long-running branch detected, running MMI tests."
echo "run_mmi_tests=true" > mmi_trigger.env
exit 0
Expand Down
2 changes: 1 addition & 1 deletion .circleci/scripts/release-create-release-pr.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ function install_github_cli ()
}

version="${CIRCLE_BRANCH/Version-v/}"
base_branch='master'
base_branch='stable'

if [[ -n "${CI_PULL_REQUEST:-}" ]]
then
Expand Down
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When you're done with your project / bugfix / feature and ready to submit a PR,
- [ ] **Meet the spec**: Make sure the PR adds functionality that matches the issue you're closing. This is especially important for bounties: sometimes design or implementation details are included in the conversation, so read carefully!
- [ ] **Close the issue**: If this PR closes an open issue, fill out the "Related issues" section with `Fixes: #$ISSUE_NUMBER`. Ex. For closing issue 418, include the line `Fixes: #418`. If it doesn't close the issue but addresses it partially, just include a reference to the issue number, like `#418`.
- [ ] **Keep it simple**: Try not to include multiple features in a single PR, and don't make extraneous changes outside the scope of your contribution. All those touched files make things harder to review ;)
- [ ] **PR against `main`**: Submit your PR against the `main` branch. This is where we merge new features so they get some time to receive extra testing before being pushed to `master` for production. If your PR is a hot-fix that needs to be published urgently, you may submit a PR against the `master` branch, but this PR will receive tighter scrutiny before merging.
- [ ] **PR against `main`**: Submit your PR against the `main` branch. This is where we merge new features so they get some time to receive extra testing before being pushed to `stable` for production. If your PR is a hot-fix that needs to be published urgently, you may submit a PR against the `stable` branch, but this PR will receive tighter scrutiny before merging.
- [ ] **Get reviewed by MetaMask Internal Developers**: All PRs require 2 approvals from MetaMask Internal Developers before merging.
- [ ] **Ensure the PR is correctly labeled.**: More detail about PR labels can be found [here](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md).
- [ ] **PR Titles**: Must adhere to the [Conventional Commits specification](https://www.conventionalcommits.org)
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/close-bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Close release bug report issue when release branch gets merged
on:
pull_request:
branches:
- master
- stable
types:
- closed

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ name: "CodeQL"

on:
push:
branches: [ main, Version-v*, cla-signatures, master, snaps ]
branches: [ main, Version-v*, cla-signatures, stable, snaps ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/create-bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
payload=$(cat <<EOF
{
"title": "v${{ env.version }} Bug Report",
"body": "**What is this bug report issue for?**\n\n1. This issue is used to track release dates on this [Github Project board](https://github.com/orgs/MetaMask/projects/86/views/1), which content then gets pulled into our metrics system.\n\n2. This issue is also used by our Zapier automations, to determine if automated notifications shall be sent on Slack for release \`${{ env.version }}\`. Notifications will only be sent as long as this issue is open.\n\n**Who created and/or closed this issue?**\n\n- This issue was automatically created by a GitHub action upon the creation of the release branch \`Version-v${{ env.version }}\`, indicating the release was cut.\n\n- This issue gets automatically closed by another GitHub action, once the \`Version-v${{ env.version }}\` branch merges into \`master\`, indicating the release is prepared for store submission.",
"body": "**What is this bug report issue for?**\n\n1. This issue is used to track release dates on this [Github Project board](https://github.com/orgs/MetaMask/projects/86/views/1), which content then gets pulled into our metrics system.\n\n2. This issue is also used by our Zapier automations, to determine if automated notifications shall be sent on Slack for release \`${{ env.version }}\`. Notifications will only be sent as long as this issue is open.\n\n**Who created and/or closed this issue?**\n\n- This issue was automatically created by a GitHub action upon the creation of the release branch \`Version-v${{ env.version }}\`, indicating the release was cut.\n\n- This issue gets automatically closed by another GitHub action, once the \`Version-v${{ env.version }}\` branch merges into \`stable\`, indicating the release is prepared for store submission.",
"labels": ["type-bug", "team-extension-platform", "regression-RC-${{ env.version }}"]
}
EOF
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
branches:
- main
- master
- stable
pull_request:
types:
- opened
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/trigger-metamask-institutional-e2e-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Trigger MetaMask Institutional E2E CI

on:
push:
branches: [ Version-v*, master ]
branches: [ Version-v*, stable ]
pull_request:
branches: [ Version-v*, master ]
branches: [ Version-v*, stable ]
types:
- opened
- reopened
Expand All @@ -14,7 +14,7 @@ on:
jobs:
trigger-mmi-e2e-ci:
runs-on: ubuntu-latest
if: ${{ (!github.event.pull_request.draft && (startsWith(github.head_ref, 'Version-v') || github.head_ref == 'master')) || (!github.event.pull_request) }}
if: ${{ (!github.event.pull_request.draft && (startsWith(github.head_ref, 'Version-v') || github.head_ref == 'stable')) || (!github.event.pull_request) }}
steps:
- name: Trigger MetaMask Institutional E2E CI
env:
Expand Down
4 changes: 2 additions & 2 deletions development/generate-rc-commits.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,13 @@ async function filterCommitsByTeam(branchA, branchB, authorTeams) {
? `https://github.com/MetaMask/metamask-extension/pull/${prMatch[1]}`
: '';

// Check if the commit message is unique and exclude 'Changelog' or 'Merge pull request' or 'master-sync' in the message
// Check if the commit message is unique and exclude 'Changelog' or 'Merge pull request' or 'stable-sync' in the message
if (
!seenMessages.has(message) &&
prMatch &&
!message.includes('changelog') &&
!message.includes('Merge pull request') &&
!message.includes('master-sync')
!message.includes('stable-sync')
) {
const labels = await getPRLabels(
'MetaMask',
Expand Down
22 changes: 11 additions & 11 deletions development/master-sync.js → development/stable-sync.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env node

// USAGE:
// Simply run `yarn master-sync` from any branch.
// This will create/update a local master-sync branch
// and get it in the state needed for a master-sync PR
// Simply run `yarn stable-sync` from any branch.
// This will create/update a local stable-sync branch
// and get it in the state needed for a stable-sync PR
// Once the script successfully completes, you just
// need to push the branch to the remote repo. This will
// likely require a `git push --force`
Expand All @@ -12,7 +12,7 @@ const { promisify } = require('util');
const exec = promisify(require('child_process').exec);

async function runGitCommands() {
const branchName = 'master-sync';
const branchName = 'stable-sync';

try {
try {
Expand Down Expand Up @@ -47,8 +47,8 @@ async function runGitCommands() {
await exec('git fetch');
console.log('Executed: git fetch');

await exec('git reset --hard origin/master');
console.log('Executed: git reset --hard origin/master');
await exec('git reset --hard origin/stable');
console.log('Executed: git reset --hard origin/stable');

try {
await exec('git merge origin/main');
Expand Down Expand Up @@ -76,11 +76,11 @@ async function runGitCommands() {
await exec('git checkout origin/main -- .');
console.log('Executed: git checkout origin/main -- .');

await exec('git checkout origin/master -- CHANGELOG.md');
console.log('Executed: git checkout origin/master -- CHANGELOG.md');
await exec('git checkout origin/stable -- CHANGELOG.md');
console.log('Executed: git checkout origin/stable -- CHANGELOG.md');

const { stdout: packageJsonContent } = await exec(
'git show origin/master:package.json',
'git show origin/stable:package.json',
);
const packageJson = JSON.parse(packageJsonContent);
const packageVersion = packageJson.version;
Expand All @@ -91,10 +91,10 @@ async function runGitCommands() {
await exec('git add .');
console.log('Executed: git add .');

await exec('git commit -m "Merge origin/main into master-sync"');
await exec('git commit -m "Merge origin/main into stable-sync"');
console.log('Executed: git commit');

console.log('Your local master-sync branch is now ready to become a PR.');
console.log('Your local stable-sync branch is now ready to become a PR.');
console.log('You likely now need to do `git push --force`');
} catch (error) {
console.error(`Error: ${error.message}`);
Expand Down
2 changes: 1 addition & 1 deletion docs/QA_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ Steps to mark a full pass of QA complete.
* Copy public key to clipboard
* Export private key

* Explore changes in master, target features that have been changed and break.
* Explore changes in stable, target features that have been changed and break.
8 changes: 4 additions & 4 deletions docs/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ In the case that a new release has sensitive changes that cannot be fully verifi

## Building

While we develop on the `main` branch, our production version is maintained on the `master` branch.
While we develop on the `main` branch, our production version is maintained on the `stable` branch.

With each pull request, the @MetaMaskBot will comment with a build of that new pull request, so after bumping the version on `main`, open a pull request against `master`, and once the pull request is reviewed and merged, you can download those builds for publication.
With each pull request, the @MetaMaskBot will comment with a build of that new pull request, so after bumping the version on `main`, open a pull request against `stable`, and once the pull request is reviewed and merged, you can download those builds for publication.

## Publishing

Expand All @@ -51,6 +51,6 @@ For this reason, when an urgent change is needed in production, its pull request

- Describe it as a hotfix.
- Use a hotfix tag.
- Should be proposed against the `master` branch.
- Should be proposed against the `stable` branch.

The version and changelog bump should then be made off the `master` branch, and then merged to `main` to bring the two branches back into sync. Further time can be saved by incorporating the version/changelog bump into the PR against `master`, since we rely on @MetaMaskBot to run tests before merging.
The version and changelog bump should then be made off the `stable` branch, and then merged to `main` to bring the two branches back into sync. Further time can be saved by incorporating the version/changelog bump into the PR against `stable`, since we rely on @MetaMaskBot to run tests before merging.
2 changes: 1 addition & 1 deletion docs/translating-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The MetaMask browser extension supports new translations added in the form of ne
- Inside that folder there should be a `messages.json`.
- An easy way to start your translation is to first **make a copy** of `app/_locales/en/messages.json` (the English translation), and then **translate the `message` key** for each in-app message.
- **The `description` key** is just to add context for what the translation is about, it **does not need to be translated**.
- Add the language to the [locales index](https://github.com/MetaMask/metamask-extension/blob/master/app/_locales/index.json) `app/_locales/index.json`
- Add the language to the [locales index](https://github.com/MetaMask/metamask-extension/blob/s/app/_locales/index.json) `app/_locales/index.json`


That's it! When MetaMask is loaded on a computer with that language set as the system language, they will see your translation instead of the default one.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"announce": "node development/announcer.js",
"storybook": "storybook dev -p 6006 -c .storybook",
"storybook:build": "storybook build -c .storybook -o storybook-build",
"storybook:deploy": "storybook-to-ghpages --existing-output-dir storybook-build --remote storybook --branch master",
"storybook:deploy": "storybook-to-ghpages --existing-output-dir storybook-build --remote storybook --branch stable",
"update-changelog": "auto-changelog update",
"generate:migration": "./development/generate-migration.sh",
"lavamoat:build": "lavamoat development/build/index.js --policy lavamoat/build-system/policy.json --policyOverride lavamoat/build-system/policy-override.json",
Expand All @@ -125,7 +125,7 @@
"audit": "yarn npm audit --recursive --environment production --severity moderate --ignore '@metamask/types (deprecation)'",
"download-builds": "tsx .devcontainer/download-builds.ts prep-build",
"download-builds:test": "tsx .devcontainer/download-builds.ts prep-build-test",
"master-sync": "node development/master-sync.js",
"stable-sync": "node development/stable-sync.js",
"update-mock-cdn": "node test/e2e/mock-cdn/update-mock-cdn-files.js",
"attributions:check": "./development/attributions-check.sh",
"attributions:generate": "./development/generate-attributions.sh",
Expand Down
Loading

0 comments on commit 79be051

Please sign in to comment.