Skip to content

Commit

Permalink
chore: rename master to main in docs (aws#2198)
Browse files Browse the repository at this point in the history
  • Loading branch information
RomainMuller authored Oct 28, 2020
1 parent ff3f3d3 commit d673439
Show file tree
Hide file tree
Showing 14 changed files with 30 additions and 27 deletions.
1 change: 0 additions & 1 deletion .github/workflows/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ name: Dependabot Pull Requests
on:
pull_request:
branches:
- master
- main
paths:
- "!**" # <-- Excludes everything by default
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docker-images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: Docker Images

on:
pull_request:
branches: [main, master, release]
branches: [main, release]
push:
branches: [main, master, release]
branches: [main, release]

jobs:
superchain:
Expand Down Expand Up @@ -82,7 +82,7 @@ jobs:
name: 'jsii-superchain.nightly'
path: ${{ runner.temp }}/jsii-superchain.nightly.tar

# Only when puhsing to master/main/release from now on
# Only when puhsing to main/release from now on
- name: Publish (nightly)
if: steps.should-run.outputs.result == 'true' && github.event_name == 'push' && github.ref != 'ref/heads/release'
run: |-
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Workflows pertaining to the main/master branch
# Workflows pertaining to the main branch
name: Main

on:
pull_request:
branches: [main, master, release]
branches: [main, release]
push:
branches: [main, master, release]
branches: [main, release]

env:
DOTNET_NOLOGO: true
Expand Down
2 changes: 1 addition & 1 deletion .mergify/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ pull_request_rules:
approved: true
changes_requested: false
conditions:
- base=master
- base=main
- author!=dependabot[bot]
- author!=dependabot-preview[bot]
- label!=contribution/core
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ will need a number of tools.
We have built a Docker image with all the required tools, which we are using for
our own CI/CD: the ["superchain" image][superchain] from.

[superchain]: https://github.com/aws/jsii/blob/master/superchain/Dockerfile
[superchain]: https://github.com/aws/jsii/blob/main/superchain/Dockerfile

The image can be built for local usage, too:

Expand Down Expand Up @@ -63,7 +63,7 @@ in your development environment.

The project is managed as a [monorepo] using [lerna].

[monorepo]: https://github.com/babel/babel/blob/master/doc/design/monorepo.md
[monorepo]: https://github.com/babel/babel/blob/main/doc/design/monorepo.md
[lerna]: https://github.com/lerna/lerna

1. Check out this respository and change directory to its root.
Expand Down Expand Up @@ -163,7 +163,7 @@ example to work from.
## Releasing
### The `jsii/superchain` Docker image

Upon merging new changes to the `master` branch, the `jsii/superchain:nightly`
Upon merging new changes to the `main` branch, the `jsii/superchain:nightly`
image will be released by TravisCI after a last validation build.

Upon making a new `jsii` release (when the GitHub release entry - and its
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ like any other class:
| [`jsii-srcmak`] | Community | Generates relocatable source code in jsii languages from typescript |
| [`jsii-docgen`] | Community | Generates markdown API documentation for jsii modules |

[`jsii`]: https://github.com/aws/jsii/tree/master/packages/jsii
[`jsii-pacmak`]: https://github.com/aws/jsii/tree/master/packages/jsii-pacmak
[`jsii-reflect`]: https://github.com/aws/jsii/tree/master/packages/jsii-reflect
[`jsii-config`]: https://github.com/aws/jsii/tree/master/packages/jsii-config
[`jsii-diff`]: https://github.com/aws/jsii/tree/master/packages/jsii-diff
[`jsii-rosetta`]: https://github.com/aws/jsii/tree/master/packages/jsii-rosetta
[`jsii`]: https://github.com/aws/jsii/tree/main/packages/jsii
[`jsii-pacmak`]: https://github.com/aws/jsii/tree/main/packages/jsii-pacmak
[`jsii-reflect`]: https://github.com/aws/jsii/tree/main/packages/jsii-reflect
[`jsii-config`]: https://github.com/aws/jsii/tree/main/packages/jsii-config
[`jsii-diff`]: https://github.com/aws/jsii/tree/main/packages/jsii-diff
[`jsii-rosetta`]: https://github.com/aws/jsii/tree/main/packages/jsii-rosetta
[`jsii-release`]: https://github.com/eladb/jsii-release
[`jsii-srcmak`]: https://github.com/eladb/jsii-srcmak
[`jsii-docgen`]: https://github.com/eladb/jsii-docgen
Expand Down
2 changes: 1 addition & 1 deletion docs/assembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ it represents. This serves as a reference for front-end language implementors.

## Schema

`.jsii` assemblies are JSON-formatted documents. The specification is mastered
`.jsii` assemblies are JSON-formatted documents. The specification is hosted
under the [`jsii-spec`](../packages/jsii-spec) package. Refer to the inline
documentation in the [`spec.ts`](../packages/jsii-spec/lib/spec.ts) file for
more information about the general content of the assembly documents.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ The `python` target requires two configuration entries:
* `distName` - the [PyPI] distribution name for the package.
* `classifiers` - a list of [trove classifiers] to declare on the package. It is
the user's responsibility to specify *valid* values (the authoritative list of
valid [trove classifiers] is mastered in the [pypa/trove-classifiers] package).
valid [trove classifiers] is defined in the [pypa/trove-classifiers] package).
* Some classifiers are automatically included (and should not be added to the
`classifiers` property) based on relevant configuration from the
`package.json` file:
Expand Down
4 changes: 2 additions & 2 deletions docs/specifications/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ living document that describes the current understanding of how the various
[components](#components) of *jsii* are operating, as well as the approaches
used to ensure consistent behavior across the various supported languages.

The document is mastered with the *jsii* codebase, making it easy to determine
The document is hosted with the *jsii* codebase, making it easy to determine
what specification was in place at the time of a give *jsii* release (by ways of
referring to the `vX.Y.Z` git tag). A single version of the specification is
considered **active** at any given time: the version of the specification that
is represented on the `HEAD` commit of the `master` branch of the [`aws/jsii`]
is represented on the `HEAD` commit of the `main` branch of the [`aws/jsii`]
repository. The **active** specification must be the base version for any update
proposal.

Expand Down
2 changes: 1 addition & 1 deletion packages/@jsii/kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ process. It provides the basic interaction API that allows language-specific
proxy object to interact with javascript objects they represent.

[jsii]: https://github.com/aws/jsii
[@jsii/runtime]: https://github.com/aws/jsii/tree/master/packages/@jsii/runtime
[@jsii/runtime]: https://github.com/aws/jsii/tree/main/packages/@jsii/runtime

See [`api.ts`](./lib/api.ts) for request/response API.

Expand Down
4 changes: 2 additions & 2 deletions packages/@jsii/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ classes, such as getting/setting properties or invoking methods is transmitted
via a simple STDIN/STDOUT protocol to the actual object hosted within the VM.

[jsii]: https://github.com/aws/jsii
[@jsii/kernel]: https://github.com/aws/jsii/tree/master/packages/@jsii/kernel
[@jsii/kernel]: https://github.com/aws/jsii/tree/main/packages/@jsii/kernel

See [STDIN/STDOUT protocol](./lib/in-out.ts) and [@jsii/kernel
API](https://github.com/aws/jsii/blob/master/packages/@jsii/kernel/lib/api.ts)
API](https://github.com/aws/jsii/blob/main/packages/@jsii/kernel/lib/api.ts)
for details.

## License
Expand Down
4 changes: 2 additions & 2 deletions packages/jsii-pacmak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ the [jsii] project.
In general, running `jsii-pacmak` from a well-configured jsii module would generate and
build a ready-to-publish package in each of the target languages defined in `package.json`.

* See [Getting Started](https://github.com/aws/jsii/blob/master/README.md#getting-started) for more details.
* See [Getting Started](https://github.com/aws/jsii/blob/main/README.md#getting-started) for more details.
* Run `jsii-pacmak --help` for full usage.

## Contributing

See [CONTRIBUTING](https://github.com/aws/jsii/blob/master/CONTRIBUTING.md)
See [CONTRIBUTING](https://github.com/aws/jsii/blob/main/CONTRIBUTING.md)
for details.

## License
Expand Down
4 changes: 4 additions & 0 deletions packages/jsii-reflect/test/independent.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ test('get full github source location for a class or method', async () => {
const klass = assembly.findType('testpkg.Foo');
expect(klass.isClassType).toBeTruthy();

expect(reflect.repositoryUrl(klass, 'main')).toBe(
'https://github.com/aws/jsii/blob/main/some/sub/dir/index.ts#L1',
);

expect(reflect.repositoryUrl(klass)).toBe(
'https://github.com/aws/jsii/blob/master/some/sub/dir/index.ts#L1',
);
Expand Down
2 changes: 1 addition & 1 deletion superchain/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ ARG COMMIT_ID
LABEL org.opencontainers.image.created=${BUILD_TIMESTAMP} \
org.opencontainers.image.title="jsii/superchain" \
org.opencontainers.image.description="An image to build cross-language artifacts with AWS jsii" \
org.opencontainers.image.url="https://github.com/aws/jsii/tree/master/superchain" \
org.opencontainers.image.url="https://github.com/aws/jsii/tree/main/superchain" \
org.opencontainers.image.source="https://github.com/aws/jsii.git" \
org.opencontainers.image.revision=$COMMIT_ID \
org.opencontainers.image.authors="Amazon Web Services (https://aws.amazon.com)"
Expand Down

0 comments on commit d673439

Please sign in to comment.