Skip to content

Commit

Permalink
Update master branch to main branch as default branch (#7063)
Browse files Browse the repository at this point in the history
# Pull Request

## πŸ“– Description

This change updates documentation and pipelines to reference `main` as default branch name instead of `master`.

## πŸ‘©β€πŸ’» Reviewer Notes

This change also updates broken links in the versioned docs to point to the archived branch. The builds may not kick off properly for this PR however since these are only pipeline and documentation updates I expect nothing should break and future PRs will not be affected.

## βœ… Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.

## ⏭ Next Steps

After this PR is merged, a new branch will be created from `master` called `main` and be set as the default branch.
  • Loading branch information
janechu authored Jan 16, 2025
1 parent f340efb commit 995724f
Show file tree
Hide file tree
Showing 103 changed files with 163 additions and 169 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Please provide a summary of the tests affected by this work and any unique strat
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [ ] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.
- [ ] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/main/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/main/CODE_OF_CONDUCT.md#our-standards) for this project.

## ⏭ Next Steps

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci-validate-platforms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ on:
workflow_dispatch:
push:
branches:
- master
- main

pull_request:
branches:
- master
- main

schedule:
- cron: 0 7 * * 3
Expand Down Expand Up @@ -37,7 +37,7 @@ jobs:

- if: ${{ github.event_name == 'pull_request' }}
run: |
git fetch --no-tags --prune --depth=1 origin +refs/heads/master:refs/remotes/origin/master
git fetch --no-tags --prune --depth=1 origin +refs/heads/main:refs/remotes/origin/main
- name: Cache multiple paths
uses: actions/cache@v2
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci-validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ on:
workflow_dispatch:
push:
branches:
- master
- main
- releases/*
pull_request:
branches:
- master
- main
- releases/*
- features/*

Expand Down
2 changes: 1 addition & 1 deletion BRANCH_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is the branch guide for the FAST repository. When contributing to this proj

## Default

The `master` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that they can be automatically checked for publishing.
The `main` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that they can be automatically checked for publishing.

## Features

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Packages are located within the `packages` folder of the repository. Each packag

### Submitting a pull request

If you'd like to contribute by fixing a bug, implementing a feature, or even correcting typos in our documentation, you'll want to submit a pull request. Before submitting a pull request, be sure to [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch (typically from master) or use the *merge* button provided by GitHub.
If you'd like to contribute by fixing a bug, implementing a feature, or even correcting typos in our documentation, you'll want to submit a pull request. Before submitting a pull request, be sure to [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch with the default branch or use the *merge* button provided by GitHub.

:::note
For additional details on branch management, read the [branch guide](./BRANCH_GUIDE.md) documentation.
Expand Down Expand Up @@ -154,15 +154,15 @@ The development, release, and work management processes must reflect this princi

### Code owners

As subject matter experts, *code owners* approve pull requests on the packages they own. There is a required minimum of one code owner for each package. *Code owners* are listed in [CODEOWNERS](https://github.com/microsoft/fast/blob/master/.github/CODEOWNERS).
As subject matter experts, *code owners* approve pull requests on the packages they own. There is a required minimum of one code owner for each package. *Code owners* are listed in [CODEOWNERS](https://github.com/microsoft/fast/blob/main/.github/CODEOWNERS).

### Contributors

*Contributors* have read access and can be anyone who has contributed a completed pull request to the project.

### Nominations & appointments

* To become a *contributor*, a community member must have a pull request approved and merged into the FAST project master branch.
* To become a *contributor*, a community member must have a pull request approved and merged into the FAST project main branch.
* To become a *collaborator*, a *contributor* will petition the *steering committee*, who will approve or deny the request.
* To become a *code owner*, a *collaborator* will be (a) nominated by a *steering committee* member or (b) petition the *steering committee*, who will approve or deny the request.
* To join the *steering committee*, a *collaborator* will be nominated by a *steering committee* member and the *steering committee*, who will approve or deny the request.
Expand Down Expand Up @@ -206,6 +206,6 @@ By making a contribution to this project, I certify that:
Several open source projects have influenced our contribution policy:

* [Project Governance @Node](https://nodejs.org/en/about/governance/)
* [Contributions @Node](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md)
* [Contributions @Node](https://github.com/nodejs/node/blob/main/CONTRIBUTING.md)
* [Open Source @GitHub](https://github.com/blog/2039-adopting-the-open-code-of-conduct)
* [Open Source examples @todogroup](https://github.com/todogroup/policies)
2 changes: 1 addition & 1 deletion azure-pipelines-ci.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pr:
- master
- main

# The `resources` specify the location and version of the 1ES PT.
resources:
Expand Down
2 changes: 1 addition & 1 deletion sites/website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ module.exports = {
items: [
{
label: "License",
href: "https://github.com/microsoft/fast/blob/master/LICENSE",
href: "https://github.com/microsoft/fast/blob/main/LICENSE",
},
{
label: "Privacy & cookies",
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/advanced/dependency-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: dependency-injection
title: Dependency Injection
sidebar_label: Dependency Injection
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/apps-and-experiences/dependency-injection.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/apps-and-experiences/dependency-injection.md
description: FAST introduces the concept of a dependency injection container.
keywords:
- dependency injection
Expand Down
4 changes: 2 additions & 2 deletions sites/website/src/docs/community/issue-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: issue-management
title: Issue Management
sidebar_label: Issue Management
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/community/issue-management.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/community/issue-management.md
description: Managing a popular GitHub repo with a small team requires a good balance between creating new features, handling investigations, and fixing bugs.
keywords:
- issue management
Expand Down Expand Up @@ -77,7 +77,7 @@ For some feature requests and bug reports, depending on the user involvement, we

## Releases

Once a PR for a `minor` or `patch` change is merged to master it will be published in the next release. Releases are published Sunday through Thursday evenings (Pacific). To learn more about our release process and planning, please see [Release Planning](./release-planning.md).
Once a PR for a `minor` or `patch` change is merged to main it will be published in the next release. Releases are published Sunday through Thursday evenings (Pacific). To learn more about our release process and planning, please see [Release Planning](./release-planning.md).

## Cleanup

Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/community/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: join
title: Joining the community
sidebar_label: Joining the community
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/community/join.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/community/join.md
description: Our community drives the rhythm and direction of FAST. By taking part, your voice will help shape our future.
keywords:
- community
Expand Down
4 changes: 2 additions & 2 deletions sites/website/src/docs/community/release-planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: release-planning
title: Release Planning
sidebar_label: Release Planning
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/community/release-planning.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/community/release-planning.md
description: In order to both provide features and fixes to our community, FAST has adopted the following release planning process and policies.
keywords:
- release planning
Expand Down Expand Up @@ -54,7 +54,7 @@ Our quarterly planning enables us to tackle larger projects and strategic work w

### Minor and patch releases

The majority of the work coming from the quarterly planning process and the weekly planning process results in minor features and bug fixes. Once a PR for a `minor` or `patch` change is merged to master it will be automatically published in the nightly release. Releases are published Sunday through Thursday evenings (Pacific). Unless there is an emergency need, we avoid releasing on Fridays or the weekend (manual intervention required by us).
The majority of the work coming from the quarterly planning process and the weekly planning process results in minor features and bug fixes. Once a PR for a `minor` or `patch` change is merged to main it will be automatically published in the nightly release. Releases are published Sunday through Thursday evenings (Pacific). Unless there is an emergency need, we avoid releasing on Fridays or the weekend (manual intervention required by us).

### Major releases

Expand Down
4 changes: 2 additions & 2 deletions sites/website/src/docs/community/writing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: writing-documentation
title: Writing documentation
sidebar_label: Writing documentation
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/community/writing-documentation.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/community/writing-documentation.md
description: Thank you for your interest in contributing to our documentation. We put together this guide to help you get started.
keywords:
- contributing
Expand All @@ -24,7 +24,7 @@ Each article begins with a YAML metadata block followed by a body written with [
id: writing-documentation
title: Writing Documentation
sidebar_label: Writing Documentation
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/community/writing-documentation.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/community/writing-documentation.md
---
```

Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: introduction
title: Introduction
sidebar_label: Introduction
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/introduction.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/introduction.md
keywords:
- introduction
- web components
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/resources/browser-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: browser-support
title: Browser Support
sidebar_label: Browser Support
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/resources/browser-support.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/resources/browser-support.md
description: View the list of browsers that have native support for the Web Components features used by fast-element.
keywords:
- browser support
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: faq
title: FAQ
sidebar_label: FAQ
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/resources/faq.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/resources/faq.md
description: A list of frequently asked questions.
keywords:
- frequently asked questions
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/resources/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: glossary
title: Glossary
sidebar_label: Glossary
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/resources/glossary.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/resources/glossary.md
description: A glossary of terms.
keywords:
- glossary of terms
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/resources/why-web-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: why-web-components
title: Why Web Components?
sidebar_label: Why Web Components?
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/resources/why-web-components.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/src/docs/resources/why-web-components.md
description: Performance, interoperability, and compatibility are a few reasons you might choose Web Components.
keywords:
- web components
Expand Down
12 changes: 6 additions & 6 deletions sites/website/src/generate-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ async function copyArticleMarkdown() {
title: "Code of Conduct",
sidebar_label: "Code of Conduct",
custom_edit_url:
"https://github.com/microsoft/fast/edit/master/CODE_OF_CONDUCT.md",
"https://github.com/microsoft/fast/edit/main/CODE_OF_CONDUCT.md",
description:
"In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.",
keywords: ["code of conduct"],
Expand All @@ -93,7 +93,7 @@ async function copyArticleMarkdown() {
title: "Contributor Guide",
sidebar_label: "Contributor Guide",
custom_edit_url:
"https://github.com/microsoft/fast/edit/master/CONTRIBUTING.md",
"https://github.com/microsoft/fast/edit/main/CONTRIBUTING.md",
description: "Guide for contributing to FAST.",
keywords: ["contributing"],
},
Expand All @@ -106,7 +106,7 @@ async function copyArticleMarkdown() {
title: "Branch Guide",
sidebar_label: "Branch Guide",
custom_edit_url:
"https://github.com/microsoft/fast/blob/master/BRANCH_GUIDE.md",
"https://github.com/microsoft/fast/blob/main/BRANCH_GUIDE.md",
desciption: "A branch guide for the FAST repository.",
keywords: ["branch guide"],
},
Expand All @@ -118,7 +118,7 @@ async function copyArticleMarkdown() {
id: "license",
title: "License",
sidebar_label: "License",
custom_edit_url: "https://github.com/microsoft/fast/edit/master/LICENSE",
custom_edit_url: "https://github.com/microsoft/fast/edit/main/LICENSE",
description: "MIT License",
keywords: ["mit license"],
},
Expand All @@ -131,7 +131,7 @@ async function copyArticleMarkdown() {
title: "Security",
sidebar_label: "Security",
custom_edit_url:
"https://github.com/microsoft/fast/edit/master/SECURITY.md",
"https://github.com/microsoft/fast/edit/main/SECURITY.md",
description:
"Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations.",
keywords: ["security"],
Expand All @@ -148,7 +148,7 @@ async function copyArticleMarkdown() {
title: "Acknowledgements",
sidebar_label: "Acknowledgements",
custom_edit_url:
"https://github.com/microsoft/fast/edit/master/packages/web-components/fast-element/docs/ACKNOWLEDGEMENTS.md",
"https://github.com/microsoft/fast/edit/main/packages/web-components/fast-element/docs/ACKNOWLEDGEMENTS.md",
description:
"There are many great open source projects that have inspired us and enabled us to build FAST.",
keywords: ["acknowlegements"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: dependency-injection
title: Dependency Injection
sidebar_label: Dependency Injection
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/versioned_docs/version-legacy/apps-and-experiences/dependency-injection.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/versioned_docs/version-legacy/apps-and-experiences/dependency-injection.md
description: FAST introduces the concept of a dependency injection container.
keywords:
- dependency injection container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: branch-guide
title: Branch Guide
sidebar_label: Branch Guide
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/versioned_docs/version-legacy/community/branch-guide.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/versioned_docs/version-legacy/community/branch-guide.md
description: This is the branch guide for the FAST repository. When contributing to this project please follow the standards defined in this guide.
keywords:
- branch guide
Expand All @@ -12,7 +12,7 @@ This is the branch guide for the FAST repository. When contributing to this proj

## Default

The `master` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that they can be automatically checked for publishing.
The `main` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that they can be automatically checked for publishing.

## Features

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: code-of-conduct
title: Code of Conduct
sidebar_label: Code of Conduct
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/versioned_docs/version-legacy/community/code-of-conduct.md
custom_edit_url: https://github.com/microsoft/fast/edit/main/sites/website/versioned_docs/version-legacy/community/code-of-conduct.md
description: In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.
keywords:
- code of conduct
Expand Down
Loading

0 comments on commit 995724f

Please sign in to comment.