'master' to 'main' (#30714)
* 'master' to 'main' * Repo reference in docs * Found another in the issue template
This commit is contained in:
parent
ba6c91779a
commit
d703a2afe0
9 changed files with 19 additions and 16 deletions
|
|
@ -5,6 +5,7 @@ on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
|
- main
|
||||||
tags:
|
tags:
|
||||||
- v2.6.*
|
- v2.6.*
|
||||||
|
|
||||||
|
|
|
||||||
3
.github/workflows/publish-docs.yml
vendored
3
.github/workflows/publish-docs.yml
vendored
|
|
@ -4,7 +4,8 @@ on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
# for testing the GH Action without merging to master,
|
- main
|
||||||
|
# for testing the GH Action without merging to main,
|
||||||
# in some cases
|
# in some cases
|
||||||
- test-publish-snapshots
|
- test-publish-snapshots
|
||||||
- docs/v*
|
- docs/v*
|
||||||
|
|
|
||||||
3
.github/workflows/publish.yml
vendored
3
.github/workflows/publish.yml
vendored
|
|
@ -4,7 +4,8 @@ on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
# for testing the GH Action without merging to master,
|
- main
|
||||||
|
# for testing the GH Action without merging to main,
|
||||||
# in some cases
|
# in some cases
|
||||||
- test-publish-snapshots
|
- test-publish-snapshots
|
||||||
tags: ["*"]
|
tags: ["*"]
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ You may also check out these [other resources](https://akka.io/get-involved/).
|
||||||
|
|
||||||
Depending on which version (or sometimes module) you want to work on, you should target a specific branch as explained below:
|
Depending on which version (or sometimes module) you want to work on, you should target a specific branch as explained below:
|
||||||
|
|
||||||
* `master` – active development branch of Akka 2.6.x
|
* `main` – active development branch of Akka 2.6.x
|
||||||
* `release-2.5` – maintenance branch of Akka 2.5.x
|
* `release-2.5` – maintenance branch of Akka 2.5.x
|
||||||
* similarly `release-2.#` branches contain legacy versions of Akka
|
* similarly `release-2.#` branches contain legacy versions of Akka
|
||||||
|
|
||||||
|
|
@ -63,7 +63,7 @@ We encourage changes that make it easier to achieve our goals efficiently.
|
||||||
|
|
||||||
### General workflow
|
### General workflow
|
||||||
|
|
||||||
The steps below describe how to get a patch into the main development branch (`master`).
|
The steps below describe how to get a patch into the main development branch (`main`).
|
||||||
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
|
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
|
||||||
|
|
||||||
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka/issues) and [existing pull requests](https://github.com/akka/akka/pulls) for existing work.
|
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka/issues) and [existing pull requests](https://github.com/akka/akka/pulls) for existing work.
|
||||||
|
|
@ -74,7 +74,7 @@ The steps are exactly the same for everyone involved in the project, including t
|
||||||
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
|
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
|
||||||
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
|
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
|
||||||
1. Once your feature is complete, prepare the commit following our [Creating Commits And Writing Commit Messages](#creating-commits-and-writing-commit-messages). For example, a good commit message would be: `Adding compression support for Manifests #22222` (note the reference to the ticket it aimed to resolve).
|
1. Once your feature is complete, prepare the commit following our [Creating Commits And Writing Commit Messages](#creating-commits-and-writing-commit-messages). For example, a good commit message would be: `Adding compression support for Manifests #22222` (note the reference to the ticket it aimed to resolve).
|
||||||
1. If it's a new feature or a change of behavior, document it on the [akka-docs](https://github.com/akka/akka/tree/master/akka-docs). When the feature touches Scala and Java DSL, document both the Scala and Java APIs.
|
1. If it's a new feature or a change of behavior, document it on the [akka-docs](https://github.com/akka/akka/tree/main/akka-docs). When the feature touches Scala and Java DSL, document both the Scala and Java APIs.
|
||||||
1. Now it's finally time to [submit the pull request](https://help.github.com/articles/using-pull-requests)!
|
1. Now it's finally time to [submit the pull request](https://help.github.com/articles/using-pull-requests)!
|
||||||
- Please make sure to include a reference to the issue you're solving *in the comment* for the Pull Request, as this will cause the PR to be linked properly with the issue. Examples of good phrases for this are: "Resolves #1234" or "Refs #1234".
|
- Please make sure to include a reference to the issue you're solving *in the comment* for the Pull Request, as this will cause the PR to be linked properly with the issue. Examples of good phrases for this are: "Resolves #1234" or "Refs #1234".
|
||||||
1. If you have not already done so, you will be asked by our CLA bot to [sign the Lightbend CLA](https://www.lightbend.com/contribute/cla) online. CLA stands for Contributor License Agreement and protects intellectual property disputes from harming the project.
|
1. If you have not already done so, you will be asked by our CLA bot to [sign the Lightbend CLA](https://www.lightbend.com/contribute/cla) online. CLA stands for Contributor License Agreement and protects intellectual property disputes from harming the project.
|
||||||
|
|
@ -234,7 +234,7 @@ To use the task, simply type `validatePullRequest`, and the output should includ
|
||||||
[info] Detected changes in directories: [akka-actor-tests, project, akka-stream, akka-docs, akka-persistence]
|
[info] Detected changes in directories: [akka-actor-tests, project, akka-stream, akka-docs, akka-persistence]
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, changes are diffed with the `master` branch when working locally. If you want to validate against a different
|
By default, changes are diffed with the `main` branch when working locally. If you want to validate against a different
|
||||||
target PR branch, you can do so by setting the PR_TARGET_BRANCH environment variable for sbt:
|
target PR branch, you can do so by setting the PR_TARGET_BRANCH environment variable for sbt:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|
@ -298,7 +298,7 @@ run `protobufGenerate`. The generated files are put in each project's `src/main/
|
||||||
The generated files are automatically transformed to use the shaded version of protobuf.
|
The generated files are automatically transformed to use the shaded version of protobuf.
|
||||||
|
|
||||||
Generation depends on protoc `3.9.0` being on the path. See [protobuf project](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation) for installation instructions, and
|
Generation depends on protoc `3.9.0` being on the path. See [protobuf project](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation) for installation instructions, and
|
||||||
[Protobuf.scala](https://github.com/akka/akka/blob/master/project/Protobuf.scala) for details of how to override
|
[Protobuf.scala](https://github.com/akka/akka/blob/main/project/Protobuf.scala) for details of how to override
|
||||||
the settings for generation.
|
the settings for generation.
|
||||||
|
|
||||||
### Pull request requirements
|
### Pull request requirements
|
||||||
|
|
@ -493,7 +493,7 @@ There are a number of ways timeouts can be defined in Akka tests. The following
|
||||||
|
|
||||||
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
|
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
|
||||||
|
|
||||||
You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/master/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
|
You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
|
||||||
|
|
||||||
### Contributing modules
|
### Contributing modules
|
||||||
|
|
||||||
|
|
@ -606,7 +606,7 @@ Akka currently uses Github Actions to run continuous integration. There are work
|
||||||
|
|
||||||
* Validating pull requests
|
* Validating pull requests
|
||||||
* Nightly builds
|
* Nightly builds
|
||||||
* Run a larger group of tests when pushing code to master branch.
|
* Run a larger group of tests when pushing code to `main` branch.
|
||||||
|
|
||||||
Anyone can propose new changes to our CI workflows, and we will gladly review them as we do for regular pull-requests.
|
Anyone can propose new changes to our CI workflows, and we will gladly review them as we do for regular pull-requests.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
Akka [](https://index.scala-lang.org/akka/akka/akka-actor)[](https://travis-ci.com/github/akka/akka)
|
Akka [](https://index.scala-lang.org/akka/akka/akka-actor)[](https://travis-ci.com/github/akka/akka)
|
||||||
====
|
====
|
||||||
|
|
||||||
We believe that writing correct concurrent & distributed, resilient and elastic applications is too hard.
|
We believe that writing correct concurrent & distributed, resilient and elastic applications is too hard.
|
||||||
|
|
@ -42,7 +42,7 @@ Contributions are *very* welcome!
|
||||||
|
|
||||||
If you see an issue that you'd like to see fixed, the best way to make it happen is to help out by submitting a pull request implementing it.
|
If you see an issue that you'd like to see fixed, the best way to make it happen is to help out by submitting a pull request implementing it.
|
||||||
|
|
||||||
Refer to the [CONTRIBUTING.md](https://github.com/akka/akka/blob/master/CONTRIBUTING.md) file for more details about the workflow,
|
Refer to the [CONTRIBUTING.md](https://github.com/akka/akka/blob/main/CONTRIBUTING.md) file for more details about the workflow,
|
||||||
and general hints on how to prepare your pull request. You can also ask for clarifications or guidance in GitHub issues directly,
|
and general hints on how to prepare your pull request. You can also ask for clarifications or guidance in GitHub issues directly,
|
||||||
or in the akka/dev chat if a more real time communication would be of benefit.
|
or in the akka/dev chat if a more real time communication would be of benefit.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -50,7 +50,7 @@ scaladoc generation build task, which is part of the release.
|
||||||
|
|
||||||
## Snapshot releases
|
## Snapshot releases
|
||||||
|
|
||||||
Snapshot releases are created from master and published to
|
Snapshot releases are created from `main` and published to
|
||||||
https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
|
https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
|
||||||
|
|
||||||
To create snapshot versions manually, use `sbt clean publishLocal`.
|
To create snapshot versions manually, use `sbt clean publishLocal`.
|
||||||
|
|
|
||||||
|
|
@ -32,5 +32,5 @@ Thanks a lot for reporting bugs and suggesting features!
|
||||||
@@@
|
@@@
|
||||||
|
|
||||||
Pull Requests fixing issues or adding functionality are very welcome.
|
Pull Requests fixing issues or adding functionality are very welcome.
|
||||||
Please read [CONTRIBUTING.md](https://github.com/akka/akka/blob/master/CONTRIBUTING.md) for
|
Please read [CONTRIBUTING.md](https://github.com/akka/akka/blob/main/CONTRIBUTING.md) for
|
||||||
more information about contributing to Akka.
|
more information about contributing to Akka.
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@ object GitHub {
|
||||||
}
|
}
|
||||||
|
|
||||||
def url(v: String): String = {
|
def url(v: String): String = {
|
||||||
val branch = if (v.endsWith("SNAPSHOT")) "master" else "v" + v
|
val branch = if (v.endsWith("SNAPSHOT")) "main" else "v" + v
|
||||||
"https://github.com/akka/akka/tree/" + branch
|
"https://github.com/akka/akka/tree/" + branch
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@ Release Akka $VERSION$
|
||||||
- [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
|
- [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
|
||||||
```
|
```
|
||||||
cd ~/www
|
cd ~/www
|
||||||
git push origin master
|
git push origin main
|
||||||
```
|
```
|
||||||
|
|
||||||
### Announcements
|
### Announcements
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue