From 86101cd7339eacd373d2494a960d1ac3d1fa3fdb Mon Sep 17 00:00:00 2001 From: Olga MaciaszekSharma Date: Mon, 26 Apr 2021 19:12:59 +0200 Subject: [PATCH] Switch from main to master. --- .github/CONTRIBUTING.md | 8 ++++---- README.adoc | 6 +++--- docs/src/main/asciidoc/README.adoc | 10 +++++----- docs/src/main/asciidoc/ghpages.sh | 10 +++++----- docs/src/main/asciidoc/spring-cloud-netflix.adoc | 8 ++++---- scripts/runAcceptanceTests.sh | 4 ++-- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index eb9a16ae6..b44059e78 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,7 +3,7 @@ Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github -tracker for issues and merging pull requests into master. If you want +tracker for issues and merging pull requests into main. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. @@ -17,7 +17,7 @@ given the ability to merge pull requests. ## Code of Conduct This project adheres to the Contributor Covenant [code of -conduct](https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report +conduct](https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. ## Code Conventions and Housekeeping @@ -27,7 +27,7 @@ added after the original pull request but before a merge. * Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the - [Spring Cloud Build](https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml) project. If using IntelliJ, you can use the + [Spring Cloud Build](https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-dependencies-parent/eclipse-code-formatter.xml) project. If using IntelliJ, you can use the [Eclipse Code Formatter Plugin](https://plugins.jetbrains.com/plugin/6546) to import the same file. * Make sure all new `.java` files to have a simple Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is @@ -38,7 +38,7 @@ added after the original pull request but before a merge. than cosmetic changes). * Add some Javadocs and, if you change the namespace, some XSD doc elements. * A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or +* If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project). * When writing a commit message please follow [these conventions](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit diff --git a/README.adoc b/README.adoc index 5cf24c12d..adc735cf4 100644 --- a/README.adoc +++ b/README.adoc @@ -21,8 +21,8 @@ Edit the files in the src/main/asciidoc/ directory instead. :sc-ext: java :project-full-name: Spring Cloud Netflix -image::https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/master.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/master"] -image::https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/master/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/master"] +image::https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/main.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/main"] +image::https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/main"] image::https://api.codacy.com/project/badge/Grade/a6885a06921e4f72a0df0b7aabd6d118["Codacy code quality", link="https://www.codacy.com/app/Spring-Cloud/spring-cloud-netflix?utm_source=github.com&utm_medium=referral&utm_content=spring-cloud/spring-cloud-netflix&utm_campaign=Badge_Grade"] @@ -384,4 +384,4 @@ IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply chec == License -The project license file is available https://raw.githubusercontent.com/spring-cloud/spring-cloud-openfeign/master/LICENSE.txt[here]. +The project license file is available https://raw.githubusercontent.com/spring-cloud/spring-cloud-netflix/main/LICENSE.txt[here]. diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 33d69caed..de0cd990c 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -1,7 +1,7 @@ include::_attributes.adoc[] -image::https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/master.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/master"] -image::https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/master/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/master"] +image::https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/main.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-netflix/tree/main"] +image::https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-netflix/branch/main"] image::https://api.codacy.com/project/badge/Grade/a6885a06921e4f72a0df0b7aabd6d118["Codacy code quality", link="https://www.codacy.com/app/Spring-Cloud/spring-cloud-netflix?utm_source=github.com&utm_medium=referral&utm_content=spring-cloud/spring-cloud-netflix&utm_campaign=Badge_Grade"] @@ -21,15 +21,15 @@ include::maintenance-mode.adoc[] == Building -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-jdk8.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/building-jdk8.adoc[] NOTE: To build the module `spring-cloud-netflix-hystrix-contract` along with the entire Netflix project run the `build.sh` script in the `scripts` directory. == Contributing -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/contributing.adoc[] == License -The project license file is available https://raw.githubusercontent.com/spring-cloud/spring-cloud-openfeign/master/LICENSE.txt[here]. \ No newline at end of file +The project license file is available https://raw.githubusercontent.com/spring-cloud/spring-cloud-netflix/main/LICENSE.txt[here]. \ No newline at end of file diff --git a/docs/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh index 55e76be19..602def303 100755 --- a/docs/src/main/asciidoc/ghpages.sh +++ b/docs/src/main/asciidoc/ghpages.sh @@ -39,7 +39,7 @@ function check_if_anything_to_sync() { } function retrieve_current_branch() { - # Code getting the name of the current branch. For master we want to publish as we did until now + # Code getting the name of the current branch. For main we want to publish as we did until now # https://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch # If there is a branch already passed will reuse it - otherwise will try to find it CURRENT_BRANCH=${BRANCH} @@ -134,8 +134,8 @@ function add_docs_from_target() { # Copies the docs by using the retrieved properties from Maven build function copy_docs_for_current_version() { - if [[ "${CURRENT_BRANCH}" == "master" ]] ; then - echo -e "Current branch is master - will copy the current docs only to the root folder" + if [[ "${CURRENT_BRANCH}" == "main" ]] ; then + echo -e "Current branch is main - will copy the current docs only to the root folder" for f in docs/target/generated-docs/*; do file=${f#docs/target/generated-docs/*} if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then @@ -216,7 +216,7 @@ function commit_changes_if_applicable() { git commit -a -m "Sync docs from ${CURRENT_BRANCH} to gh-pages" && COMMIT_SUCCESSFUL="yes" || echo "Failed to commit changes" # Uncomment the following push if you want to auto push to - # the gh-pages branch whenever you commit to master locally. + # the gh-pages branch whenever you commit to main locally. # This is a little extreme. Use with care! ################################################################### if [[ "${COMMIT_SUCCESSFUL}" == "yes" ]] ; then @@ -249,7 +249,7 @@ The idea of this script is to update gh-pages branch with the generated docs. Wi the script will work in the following manner: - if there's no gh-pages / target for docs module then the script ends -- for master branch the generated docs are copied to the root of gh-pages branch +- for main branch the generated docs are copied to the root of gh-pages branch - for any other branch (if that branch is whitelisted) a subfolder with branch name is created and docs are copied there - if the version switch is passed (-v) then a tag with (v) prefix will be retrieved and a folder diff --git a/docs/src/main/asciidoc/spring-cloud-netflix.adoc b/docs/src/main/asciidoc/spring-cloud-netflix.adoc index 667e2f5dc..e5f79ceb8 100755 --- a/docs/src/main/asciidoc/spring-cloud-netflix.adoc +++ b/docs/src/main/asciidoc/spring-cloud-netflix.adoc @@ -1,13 +1,13 @@ include::_attributes.adoc[] -:github-tag: master +:github-tag: main :github-repo: spring-cloud/spring-cloud-netflix :github-raw: https://raw.github.com/{github-repo}/{github-tag} :github-code: https://github.com/{github-repo}/tree/{github-tag} :all: {asterisk}{asterisk} :nofooter: -:branch: master +:branch: main = Spring Cloud Netflix @@ -1620,7 +1620,7 @@ The following example maps all paths in "/api/{all}" to the Zuul filter chain: === Disable Zuul Filters Zuul for Spring Cloud comes with a number of `ZuulFilter` beans enabled by default in both proxy and server mode. -See https://github.com/spring-cloud/spring-cloud-netflix/tree/master/spring-cloud-netflix-zuul/src/main/java/org/springframework/cloud/netflix/zuul/filters[the Zuul filters package] for the list of filters that you can enable. +See https://github.com/spring-cloud/spring-cloud-netflix/tree/main/spring-cloud-netflix-zuul/src/main/java/org/springframework/cloud/netflix/zuul/filters[the Zuul filters package] for the list of filters that you can enable. If you want to disable one, set `zuul...disable=true`. By convention, the package after `filters` is the Zuul filter type. For example to disable `org.springframework.cloud.netflix.zuul.filters.post.SendResponseFilter`, set `zuul.SendResponseFilter.post.disable=true`. @@ -1825,7 +1825,7 @@ This path can be changed with the `zuul.servlet-path` property. To pass information between filters, Zuul uses a https://github.com/Netflix/zuul/blob/1.x/zuul-core/src/main/java/com/netflix/zuul/context/RequestContext.java[`RequestContext`]. Its data is held in a `ThreadLocal` specific to each request. Information about where to route requests, errors, and the actual `HttpServletRequest` and `HttpServletResponse` are stored there. -The `RequestContext` extends `ConcurrentHashMap`, so anything can be stored in the context. https://github.com/spring-cloud/spring-cloud-netflix/blob/master/spring-cloud-netflix-zuul/src/main/java/org/springframework/cloud/netflix/zuul/filters/support/FilterConstants.java[`FilterConstants`] contains the keys used by the filters installed by Spring Cloud Netflix (more on these <>). +The `RequestContext` extends `ConcurrentHashMap`, so anything can be stored in the context. https://github.com/spring-cloud/spring-cloud-netflix/blob/main/spring-cloud-netflix-zuul/src/main/java/org/springframework/cloud/netflix/zuul/filters/support/FilterConstants.java[`FilterConstants`] contains the keys used by the filters installed by Spring Cloud Netflix (more on these <>). ==== `@EnableZuulProxy` vs. `@EnableZuulServer` diff --git a/scripts/runAcceptanceTests.sh b/scripts/runAcceptanceTests.sh index 97a9d6bf7..cbaea6bce 100755 --- a/scripts/runAcceptanceTests.sh +++ b/scripts/runAcceptanceTests.sh @@ -4,7 +4,7 @@ set -o errexit mkdir -p target -SCRIPT_URL="https://raw.githubusercontent.com/spring-cloud-samples/brewery/master/runAcceptanceTests.sh" +SCRIPT_URL="https://raw.githubusercontent.com/spring-cloud-samples/brewery/main/runAcceptanceTests.sh" AT_WHAT_TO_TEST="EUREKA" cd target @@ -18,7 +18,7 @@ echo "Killing all running apps" ./runAcceptanceTests.sh -t "${AT_WHAT_TO_TEST}" --killattheend -SCRIPT_URL="https://raw.githubusercontent.com/spring-cloud-samples/tests/master/scripts/runTests.sh" +SCRIPT_URL="https://raw.githubusercontent.com/spring-cloud-samples/tests/main/scripts/runTests.sh" curl "${SCRIPT_URL}" --output runIntegrationTests.sh