Skip to content

Commit 4bf2eb8

Browse files
authored
chore: Update references of master to main (#316)
Signed-off-by: Lucas Holmquist <lholmqui@redhat.com>
1 parent b5cf886 commit 4bf2eb8

7 files changed

+33
-31
lines changed

.github/pull-request-template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- General PR guidelines:
22
3-
Most PRs should be opened against the master branch.
3+
Most PRs should be opened against the main branch.
44
55
-->
66

77
## Proposed Changes
88

9-
-
9+
-
1010
-
1111
-
1212

.github/workflows/nodejs-ci-action.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Node.js CI
55

66
on:
77
push:
8-
branches: [ master ]
8+
branches: [ main ]
99
pull_request:
10-
branches: [ master ]
10+
branches: [ main ]
1111

1212
jobs:
1313
build:

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ check your code style for linting errors without running tests, you can just
3838
run `npm run lint`. If there are errors, you can usually fix them automatically
3939
by running `npm run fix`.
4040

41-
Linting rules are declared in [.eslintrc](https://github.com/cloudevents/sdk-javascript/blob/master/.eslintrc).
41+
Linting rules are declared in [.eslintrc](https://github.com/cloudevents/sdk-javascript/blob/main/.eslintrc).

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ const ce2 = ce.cloneWith({extension: "Value"});
110110
### Example Applications
111111

112112
There are a few trivial example applications in
113-
[the examples folder](https://github.com/cloudevents/sdk-javascript/tree/master/examples).
113+
[the examples folder](https://github.com/cloudevents/sdk-javascript/tree/main/examples).
114114
There you will find Express.js, TypeScript and Websocket examples.
115115

116116
## Supported specification features
@@ -150,7 +150,7 @@ There you will find Express.js, TypeScript and Websocket examples.
150150
## Contributing
151151

152152
We love contributions from the community! Please check the
153-
[Contributor's Guide](https://github.com/cloudevents/sdk-javascript/blob/master/CONTRIBUTING.md)
153+
[Contributor's Guide](https://github.com/cloudevents/sdk-javascript/blob/main/CONTRIBUTING.md)
154154
for information on how to get involved.
155155

156156
Each SDK may have its own unique processes, tooling and guidelines, common

RELEASE_GUIDELINES.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ To prepare for a new release, create a [new issue](https://github.com/cloudevent
66

77
For example: "Proposal for 3.2.0 release", or something similar. If you are not sure which version is the next version to be released, you can run `npm run release -- --dry-run` to find out what the next version will be.
88

9-
The body of the issue should be the commits that will be part of the release. This can be easily accomplished by running a git log command with a defined **range**. This range should start at the most recent version tag and end at the latest commit in the master branch.
9+
The body of the issue should be the commits that will be part of the release. This can be easily accomplished by running a git log command with a defined **range**. This range should start at the most recent version tag and end at the latest commit in the main branch.
1010

1111
For example:
1212

1313
```
14-
git log v3.0.1..upstream/master --oneline
14+
git log v3.0.1..upstream/main --oneline
1515
```
1616

17-
This will output all the commits from the 3.0.1 tag to the latest commits in the remote upstream/master branch.
17+
This will output all the commits from the 3.0.1 tag to the latest commits in the remote upstream/main branch.
1818

1919
This output should be pasted into the issue as normal text. This will allow Github to magically turn all commit hashes and PR/Issues numbers to links.
2020

@@ -37,7 +37,7 @@ npm run release
3737
This will update the CHANGELOG.md and create a new tag based on the version. This can then be pushed upstream by doing:
3838

3939
```
40-
git push upstream master --follow-tags
40+
git push upstream main --follow-tags
4141
```
4242

4343
### Create the release on GitHub

maintainer_guidelines.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ When landing pull requests, be sure to check the first line uses an appropriate
2626

2727
## Branch Management
2828

29-
The `master` branch is the bleeding edge. New major versions of the module
29+
The `main` branch is the bleeding edge. New major versions of the module
3030
are cut from this branch and tagged. If you intend to submit a pull request
31-
you should use `master HEAD` as your starting point.
31+
you should use `main HEAD` as your starting point.
3232

3333
Each major release will result in a new branch and tag. For example, the
3434
release of version 1.0.0 of the module will result in a `v1.0.0` tag on the
3535
release commit, and a new branch `v1.x.y` for subsequent minor and patch
3636
level releases of that major version. However, development will continue
37-
apace on `master` for the next major version - e.g. 2.0.0. Version branches
37+
apace on `main` for the next major version - e.g. 2.0.0. Version branches
3838
are only created for each major version. Minor and patch level releases
3939
are simply tagged.
4040

pr_guidelines.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ a pull request in this repository. We hope it will help you have an easy time
55
managing your work and a positive, satisfying experience when contributing
66
your code. Thanks for getting involved! :rocket:
77

8-
* [Getting Started](#getting-started)
9-
* [Branches](#branches)
10-
* [Commit Messages](#commit-messages)
11-
* [Staying current with master](#staying-current-with-master)
12-
* [Style Guide](#style-guide)
13-
* [Submitting and Updating a Pull Request](#submitting-and-updating-a-pull-request)
14-
* [Congratulations!](#congratulations)
8+
- [Pull Request Guidelines](#pull-request-guidelines)
9+
- [Getting Started](#getting-started)
10+
- [Branches](#branches)
11+
- [Commit Messages](#commit-messages)
12+
- [Signing your commits](#signing-your-commits)
13+
- [Staying Current with `main`](#staying-current-with-main)
14+
- [Style Guide](#style-guide)
15+
- [Submitting and Updating Your Pull Request](#submitting-and-updating-your-pull-request)
16+
- [Congratulations!](#congratulations)
1517

1618
## Getting Started
1719

@@ -35,7 +37,7 @@ you might create a branch named `48-fix-http-agent-error`.
3537

3638
```console
3739
git fetch upstream
38-
git reset --hard upstream/master
40+
git reset --hard upstream/main
3941
git checkout FETCH_HEAD
4042
git checkout -b 48-fix-http-agent-error
4143
```
@@ -102,19 +104,19 @@ Date: Thu Feb 2 11:41:15 2018 -0800
102104
Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will
103105
be rejected by the automated DCO check.
104106

105-
## Staying Current with `master`
107+
## Staying Current with `main`
106108

107-
As you are working on your branch, changes may happen on `master`. Before
109+
As you are working on your branch, changes may happen on `main`. Before
108110
submitting your pull request, be sure that your branch has been updated
109111
with the latest commits.
110112

111113
```console
112114
git fetch upstream
113-
git rebase upstream/master
115+
git rebase upstream/main
114116
```
115117

116118
This may cause conflicts if the files you are changing on your branch are
117-
also changed on master. Error messages from `git` will indicate if conflicts
119+
also changed on main. Error messages from `git` will indicate if conflicts
118120
exist and what files need attention. Resolve the conflicts in each file, then
119121
continue with the rebase with `git rebase --continue`.
120122

@@ -134,22 +136,22 @@ check your code style for linting errors without running tests, you can just
134136
run `npm run lint`. If there are errors, you can usually fix them automatically
135137
by running `npm run fix`.
136138

137-
Linting rules are declared in [.eslintrc](https://github.com/cloudevents/sdk-javascript/blob/master/.eslintrc).
139+
Linting rules are declared in [.eslintrc](https://github.com/cloudevents/sdk-javascript/blob/main/.eslintrc).
138140

139141
## Submitting and Updating Your Pull Request
140142

141143
Before submitting a pull request, you should make sure that all of the tests
142144
successfully pass by running `npm test`.
143145

144-
Once you have sent your pull request, `master` may continue to evolve
145-
before your pull request has landed. If there are any commits on `master`
146+
Once you have sent your pull request, `main` may continue to evolve
147+
before your pull request has landed. If there are any commits on `main`
146148
that conflict with your changes, you may need to update your branch with
147149
these changes before the pull request can land. Resolve conflicts the same
148150
way as before.
149151

150152
```console
151153
git fetch upstream
152-
git rebase upstream/master
154+
git rebase upstream/main
153155
# fix any potential conflicts
154156
git push -f origin 48-fix-http-agent-error
155157
```
@@ -166,7 +168,7 @@ for details.
166168

167169
```console
168170
git commit -m "fixup: fix typo"
169-
git rebase -i upstream/master # follow git instructions
171+
git rebase -i upstream/main # follow git instructions
170172
```
171173

172174
Once you have rebased your commits, you can force push to your fork as before.

0 commit comments

Comments
 (0)