Skip to content

Commit

Permalink
chore(docs): Replace 'master' with 'main' throughout
Browse files Browse the repository at this point in the history
Certain references to 'master' haven't been removed yet, see
issue #5698, issue #5699, issue #5700 for more complex followups.
  • Loading branch information
jaredhirsch authored and dannycoates committed Jun 25, 2020
1 parent e440dae commit 20a0acf
Show file tree
Hide file tree
Showing 73 changed files with 207 additions and 208 deletions.
22 changes: 11 additions & 11 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -225,51 +225,51 @@ workflows:
- test-many:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-package:
name: test-auth-server
package: fxa-auth-server
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-0:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-1:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-2:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-3:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-4:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-content-server-5:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
- test-email-service:
Expand All @@ -286,7 +286,7 @@ workflows:
- build-and-deploy-storybooks:
filters:
branches:
ignore: master
ignore: main
tags:
ignore: /.*/
deploy_branch:
Expand All @@ -295,15 +295,15 @@ workflows:
filters:
branches:
only:
- master
- main
- /^feature.*/
- /^dockerpush.*/
tags:
ignore: /.*/
- build-and-deploy-storybooks:
filters:
branches:
only: master
only: main
tags:
ignore: /.*/
test_and_deploy_tag:
Expand Down
2 changes: 1 addition & 1 deletion .circleci/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ if [[ "$(docker images -q "$MODULE")" == "" ]]; then
exit 0
fi

if [ "${CIRCLE_BRANCH}" == "master" ]; then
if [ "${CIRCLE_BRANCH}" == "main" ]; then
DOCKER_TAG="latest"
fi

Expand Down
8 changes: 5 additions & 3 deletions .circleci/modules-to-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,12 @@ async function main() {
for (const mod of toRun) {
console.log(mod);
}
} else if (branch === 'master') {
}
else if (branch === 'main') {
console.log('all');
} else {
//TODO diff master..branch
}
else {
//TODO diff main..branch
console.log('all');
}
}
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Before submitting a PR:
When submitting a PR:

- You agree to and have the legal right to license your code under the project's [license](/LICENSE).
- Base your branch off the current `master`.
- Base your branch off the current `main`.
- Add both your code and new tests if relevant.
- Run `grunt lint` and `npm test` to make sure your code passes linting and tests.
- Please do not include merge commits in pull requests; include only commits with the new relevant code.
- Your commit message must follow the
[commit guidelines](https://github.com/mozilla/fxa/blob/master/CONTRIBUTING.md#git-commit-guidelines).
[commit guidelines](https://github.com/mozilla/fxa/blob/main/CONTRIBUTING.md#git-commit-guidelines).
- To skip CI tests add the "🙈 skip ci" github label to the PR.
- You can skip only specific packages by also adding the corresponding "fxa-" label, for example "fxa-content-server".

Expand All @@ -72,7 +72,7 @@ This project is production Mozilla code and subject to our [engineering practice

## Git Commit Guidelines

We loosely follow the [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#type) of `<type>(<scope>): <subject>` where `type` must be one of:
We loosely follow the [Angular commit guidelines](https://github.com/angular/angular.js/blob/main/CONTRIBUTING.md#type) of `<type>(<scope>): <subject>` where `type` must be one of:

- **feat**: A new feature
- **fix**: A bug fix
Expand Down Expand Up @@ -139,7 +139,7 @@ if it's a partial fix.
### npm

We use [npm](http://npmjs.com/) to manage dependencies. Required components are [automatically
installed](https://github.com/mozilla/fxa/blob/master/package.json#L6) when you install this project.
installed](https://github.com/mozilla/fxa/blob/main/package.json#L6) when you install this project.

### L10N

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The Firefox Accounts (fxa) monorepo

Note: If `yarn install` fails, ensure your `yarn -v` is at least `1.22.0`.

Note this starts up all required services, including Redis, MySQL, and Memcached. It is recommended that you don't run these services yourself, or occupy any of the [server ports](https://github.com/mozilla/fxa/blob/master/mysql_servers.json). Doing so may result in errors.
Note this starts up all required services, including Redis, MySQL, and Memcached. It is recommended that you don't run these services yourself, or occupy any of the [server ports](https://github.com/mozilla/fxa/blob/main/mysql_servers.json). Doing so may result in errors.
4. Visit [localhost:3030](http://localhost:3030/).
Expand Down Expand Up @@ -73,7 +73,7 @@ The most common commands are:
### Contributing
See the separate [CONTRIBUTING.md](https://github.com/mozilla/fxa/blob/master/CONTRIBUTING.md) to learn how to contribute.
See the separate [CONTRIBUTING.md](https://github.com/mozilla/fxa/blob/main/CONTRIBUTING.md) to learn how to contribute.
### Workflow
Expand Down Expand Up @@ -217,8 +217,8 @@ When developing locally you may need to set up some secrets in order to effectiv
Check out the Secrets section in the following READMEs:
- [fxa-auth-server](https://github.com/mozilla/fxa/tree/master/packages/fxa-auth-server#secrets)
- [fxa-payments-server](https://github.com/mozilla/fxa/tree/master/packages/fxa-payments-server#secrets)
- [fxa-auth-server](https://github.com/mozilla/fxa/tree/main/packages/fxa-auth-server#secrets)
- [fxa-payments-server](https://github.com/mozilla/fxa/tree/main/packages/fxa-payments-server#secrets)
---
Expand All @@ -245,7 +245,7 @@ Note that this invokes the same test suite that CI uses, and is not necessarily

#### Emulating CI environment

It is possible to run various test suites (known as Jobs) acting as Circle CI. This is useful if you're encountering CI-specific failures. Please refer to [this documentation](https://github.com/mozilla/fxa/tree/master/.circleci#local-testing).
It is possible to run various test suites (known as Jobs) acting as Circle CI. This is useful if you're encountering CI-specific failures. Please refer to [this documentation](https://github.com/mozilla/fxa/tree/main/.circleci#local-testing).

---

Expand Down
2 changes: 1 addition & 1 deletion _dev/docker/circleci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ curl -u $CIRCLECI_API_TOKEN \
```

- `$CIRCLECI_API_TOKEN` is your personal API token from https://app.circleci.com/settings/user/tokens
- `$GITHUB_BRANCH` is the branch you'd like to build & deploy to docker hub (this may be `master`)
- `$GITHUB_BRANCH` is the branch you'd like to build & deploy to docker hub (this may be `main`)
2 changes: 1 addition & 1 deletion _scripts/gh-pages.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

echo "Branch: $CIRCLE_BRANCH Pull request: $CIRCLE_PULL_REQUEST"

if [ "$CIRCLE_BRANCH" != "master" ] || [ "$CIRCLE_PULL_REQUEST" != "" ]; then
if [ "$CIRCLE_BRANCH" != "main" ] || [ "$CIRCLE_PULL_REQUEST" != "" ]; then
echo "Not building docs."
exit 0
fi
Expand Down
2 changes: 1 addition & 1 deletion _scripts/upload-assets-to-cdn.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

echo ""
echo "Usage:"
echo " Checkout HEAD of master of https://github.com/mozilla/fxa, and from"
echo " Checkout HEAD of main of https://github.com/mozilla/fxa, and from"
echo " ./fxa, run ./_scripts/upload-assets-to-cdn.sh."
echo ""
echo "Your current branch is $(git branch --show-current)"
Expand Down
88 changes: 44 additions & 44 deletions docs/adr/0003-event-broker-for-subscription-platform.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Event Broker for Subscription Platform

* Deciders: Ben Bangert, Phil Booth, Ryan Kelly, Shane Tomlinson
* Date: 2019-05-14
- Deciders: Ben Bangert, Phil Booth, Ryan Kelly, Shane Tomlinson
- Date: 2019-05-14

## Context and Problem Statement

Expand All @@ -28,83 +28,83 @@ query load on existing FxA services.

## Decision Drivers

* Subscription services deadlines
* Effort required and experience available for FxA changes
* Separation of concerns from existing FxA microservices
* Difficulty of schema migrations in existing FxA microservices
* Suitability of existing FxA databases for large-scale event storage
* Architectural desire to treat FxA Auth and OAuth as one (Merging
- Subscription services deadlines
- Effort required and experience available for FxA changes
- Separation of concerns from existing FxA microservices
- Difficulty of schema migrations in existing FxA microservices
- Suitability of existing FxA databases for large-scale event storage
- Architectural desire to treat FxA Auth and OAuth as one (Merging
in-progress)

## Considered Options

* Implementing RP notification as a FxA Auth Service feature
* A. Storing webhook and login activity in FxA Auth Service
* Implementing RP notification as a new FxA Event Broker service
* B. Storing webhook and login activity in FxA Auth Service
* C. Storing webhook and login activity in FxA Event Broker
- Implementing RP notification as a FxA Auth Service feature
- A. Storing webhook and login activity in FxA Auth Service
- Implementing RP notification as a new FxA Event Broker service
- B. Storing webhook and login activity in FxA Auth Service
- C. Storing webhook and login activity in FxA Event Broker

## Decision Outcome

Chosen Option: C. Implementing RP notification as a new FxA Event Broker service
with webhook and login activity stored in FxA Event Broker, because

* Less subscription platform timeline risk to store new data in new database vs.
- Less subscription platform timeline risk to store new data in new database vs.
modify existing FxA OAuth database.
* Storing events at scale has database requirements that don't fit in well with
- Storing events at scale has database requirements that don't fit in well with
the limitations with MySQL encountered in FxA Auth/OAuth.
* Having FxA Auth be the only store of which RP to notify would require each
- Having FxA Auth be the only store of which RP to notify would require each
notification to also include what RPs to notify, increasing the load on the
FxA Auth database.

## Pros and Cons of the Options

### A. Implementing RP notification as a FxA Auth Service feature w/webhook & login activity

* Description
* FxA Auth Service has additional feature code added to perform webhook
- Description
- FxA Auth Service has additional feature code added to perform webhook
deliveries to RPs.
* FxA Auth Service stores login activity and webhook mapping to OAuth Clients
* Pros
* Auth service has direct access to subscription capability mapping and
- FxA Auth Service stores login activity and webhook mapping to OAuth Clients
- Pros
- Auth service has direct access to subscription capability mapping and
OAuth webhook URLs.
* Cons
* Event logs for each user are not well suited for existing MySQL database.
* Additional database schema migrations needed.
* Later features needing to query for user events could impact FxA Auth Service
- Cons
- Event logs for each user are not well suited for existing MySQL database.
- Additional database schema migrations needed.
- Later features needing to query for user events could impact FxA Auth Service
availability.

### B. Implementing RP notification as a new FxA Event Broker service w/webhook & login activity in FxA Auth Service

* Description
* FxA Event Broker performs webhook deliveries to RPs.
* FxA Auth Service stores login activity and webhook mapping to OAuth Clients
* FxA Auth Server includes RPs that should be notified in the relevant
- Description
- FxA Event Broker performs webhook deliveries to RPs.
- FxA Auth Service stores login activity and webhook mapping to OAuth Clients
- FxA Auth Server includes RPs that should be notified in the relevant
Service Notifications.
* FxA Event Broker caches new OAuth /clients request that indicates
- FxA Event Broker caches new OAuth /clients request that indicates
subscription capabilities per RP.
* Pros
* Division of event storing and distribution to a service that can be built
- Pros
- Division of event storing and distribution to a service that can be built
specifically for that function.
* Cons
* Queries to FxA Auth Service required for each message to determine whether
- Cons
- Queries to FxA Auth Service required for each message to determine whether
to deliver to an RP could impact FxA Auth Service availability.
* FxA OAuth server should still have a record of which RPs a user has logged
- FxA OAuth server should still have a record of which RPs a user has logged
into so a later issue to add this is still needed.

### C. Implementing RP notification as a new FxA Event Broker service w/webhook & login activity in FxA Event Broker

* Description
* FxA Event Broker performs webhook deliveries to RPs.
* FxA Event Broker caches new OAuth /clients request that indicates
- Description
- FxA Event Broker performs webhook deliveries to RPs.
- FxA Event Broker caches new OAuth /clients request that indicates
subscription capabilities per RP.
* FxA Event Broker logs events and can determine which RPs a user has logged
- FxA Event Broker logs events and can determine which RPs a user has logged
into without any external service queries.
* Pros
* Division of event storing and distribution to a service that can be built
- Pros
- Division of event storing and distribution to a service that can be built
specifically for that function.
* Cons
* FxA OAuth server should still have a record of which RPs a user has logged
- Cons
- FxA OAuth server should still have a record of which RPs a user has logged
into so a later issue to add this is still needed.

[Firefox Service Notifications]: https://github.com/mozilla/fxa/blob/master/packages/fxa-auth-server/docs/service_notifications.md
[firefox service notifications]: https://github.com/mozilla/fxa/blob/main/packages/fxa-auth-server/docs/service_notifications.md
8 changes: 4 additions & 4 deletions docs/adr/0010-transition-fxa-from-backbone-to-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Context and Problem Statement

When Firefox Accounts was created some 6-7 years ago, the front-end Javascript framework and HTML templating options were limited significantly to those available at the time. This ADR details the pros and cons of various FE libraries and frameworks, and why it is desirable for FxA to move to a different technology. It does not cover _how_ we will begin the conversion which can be [read about here](https://github.com/mozilla/fxa/blob/master/docs/adr/0011-create-new-react-app-for-settings-redesign.md).
When Firefox Accounts was created some 6-7 years ago, the front-end Javascript framework and HTML templating options were limited significantly to those available at the time. This ADR details the pros and cons of various FE libraries and frameworks, and why it is desirable for FxA to move to a different technology. It does not cover _how_ we will begin the conversion which can be [read about here](https://github.com/mozilla/fxa/blob/main/docs/adr/0011-create-new-react-app-for-settings-redesign.md).

While Backbone and Mustache have served their purposes for FxA thus far, other modern libraries and frameworks not only offer more appealing architecture and developer conveniences, but also offer better data predictability, potential performance boosts, and a strong community of online support.

Expand Down Expand Up @@ -54,7 +54,7 @@ In the end, it is recognized that Vue _may_ have been a good option for FxA, but
- As Backbone's popularity continues to wane, we will likely be presented with challenges in the future around support, documentation, features, and developer knowledge or experience with the framework.
- We'd be giving a hard pass on all of the benefits we would gain from another library or framework - i.e. modern approaches, better data clarity and typing, performance optimizations, etc.

Note: also see pros/cons listed on Backbone in general [in this ADR](https://github.com/mozilla/fxa/blob/master/docs/adr/0002-use-react-redux-and-typescript-for-subscription-management-pages.md)
Note: also see pros/cons listed on Backbone in general [in this ADR](https://github.com/mozilla/fxa/blob/main/docs/adr/0002-use-react-redux-and-typescript-for-subscription-management-pages.md)

### Options B - E - Common Pros & Cons

Expand Down Expand Up @@ -149,8 +149,8 @@ Using web components with the [Polymer Project](https://www.polymer-project.org/

## Links

- [Create a new React app for Settings Redesign](https://github.com/mozilla/fxa/blob/master/docs/adr/0011-create-new-react-app-for-settings-redesign.md)
- Other Backbone pros/cons: [subscription management stack ADR](https://github.com/mozilla/fxa/blob/master/docs/adr/0002-use-react-redux-and-typescript-for-subscription-management-pages.md)
- [Create a new React app for Settings Redesign](https://github.com/mozilla/fxa/blob/main/docs/adr/0011-create-new-react-app-for-settings-redesign.md)
- Other Backbone pros/cons: [subscription management stack ADR](https://github.com/mozilla/fxa/blob/main/docs/adr/0002-use-react-redux-and-typescript-for-subscription-management-pages.md)
- [Facebook switches licensing](https://www.freecodecamp.org/news/facebook-just-changed-the-license-on-react-heres-a-2-minute-explanation-why-5878478913b2/)
- [Banana, monkey, jungle problem](http://rcardin.github.io/design/programming/oop/fp/2018/07/27/the-secret-life-of-objects-part-2.html#the-banana-monkey-jungle-problem)
- [React](https://github.com/facebook/react)
Expand Down
Loading

0 comments on commit 20a0acf

Please sign in to comment.