You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by fp...@apache.org on 2021/04/21 20:11:27 UTC
[shiro] branch main updated: [INFRA-21748] Rename Shiro master
branch to main
This is an automated email from the ASF dual-hosted git repository.
fpapon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shiro.git
The following commit(s) were added to refs/heads/main by this push:
new 48ff4cc [INFRA-21748] Rename Shiro master branch to main
new 9e68eb4 Merge pull request #295 from fpapon/INFRA-21748
48ff4cc is described below
commit 48ff4cc66638633f8fae7a2fd30718f03d831713
Author: francois papon <fp...@apache.org>
AuthorDate: Tue Apr 20 23:02:57 2021 +0200
[INFRA-21748] Rename Shiro master branch to main
---
.jenkins.groovy | 8 ++++----
CONTRIBUTING.md | 53 ++++++++++++++++++++++++++++++++---------------------
pom.xml | 2 +-
3 files changed, 37 insertions(+), 26 deletions(-)
diff --git a/.jenkins.groovy b/.jenkins.groovy
index 91a84d4..f45a936 100644
--- a/.jenkins.groovy
+++ b/.jenkins.groovy
@@ -104,7 +104,7 @@ pipeline {
stage('Deploy') {
when {
allOf {
- expression { env.BRANCH_NAME ==~ /(1.6.x|1.7.x|master|main)/ }
+ expression { env.BRANCH_NAME ==~ /(1.6.x|1.7.x|main)/ }
expression { MATRIX_JDK == 'jdk_11_latest' }
// is not a PR (GitHub) / MergeRequest (GitLab) / Change (Gerrit)?
not { changeRequest() }
@@ -123,7 +123,7 @@ pipeline {
// If this build failed, send an email to the list.
failure {
script {
- if (env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "master" || env.BRANCH_NAME == "main") {
+ if (env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "main") {
emailext(
subject: "[BUILD-FAILURE]: Job '${env.JOB_NAME} [${env.BRANCH_NAME}] [${env.BUILD_NUMBER}]'",
body: """
@@ -140,7 +140,7 @@ Check console output at "<a href="${env.BUILD_URL}">${env.JOB_NAME} [${env.BRANC
// If this build didn't fail, but there were failing tests, send an email to the list.
unstable {
script {
- if (env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "master" || env.BRANCH_NAME == "main") {
+ if (env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "main") {
emailext(
subject: "[BUILD-UNSTABLE]: Job '${env.JOB_NAME} [${env.BRANCH_NAME}] [${env.BUILD_NUMBER}]'",
body: """
@@ -160,7 +160,7 @@ Check console output at "<a href="${env.BUILD_URL}">${env.JOB_NAME} [${env.BRANC
// (in this cae we probably don't have to do any post-build analysis)
cleanWs()
script {
- if ((env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "master" || env.BRANCH_NAME == "main")
+ if ((env.BRANCH_NAME == "1.6.x" || env.BRANCH_NAME == "1.7.x" || env.BRANCH_NAME == "main")
&& (currentBuild.previousBuild != null) && (currentBuild.previousBuild.result != 'SUCCESS')) {
emailext(
subject: "[BUILD-STABLE]: Job '${env.JOB_NAME} [${env.BRANCH_NAME}] [${env.BUILD_NUMBER}]'",
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3c4052e..3953cf3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,7 +13,10 @@ Fork the code
In your browser, navigate to: [https://github.com/apache/shiro](https://github.com/apache/shiro)
-Fork the repository by clicking on the 'Fork' button on the top right hand side. The fork will happen and you will be taken to your own fork of the repository. Copy the Git repository URL by clicking on the clipboard next to the URL on the right hand side of the page under '**HTTPS** clone URL'. You will paste this URL when doing the following `git clone` command.
+Fork the repository by clicking on the 'Fork' button on the top right hand side.
+The fork will happen and you will be taken to your own fork of the repository.
+Copy the Git repository URL by clicking on the clipboard next to the URL on the right hand side of the page under '**HTTPS** clone URL'.
+You will paste this URL when doing the following `git clone` command.
On your computer, follow these steps to setup a local repository for working on Apache Shiro:
@@ -21,16 +24,18 @@ On your computer, follow these steps to setup a local repository for working on
$ git clone https://github.com/YOUR_ACCOUNT/shiro.git
$ cd shiro
$ git remote add upstream https://github.com/apache/shiro.git
-$ git checkout master
+$ git checkout main
$ git fetch upstream
-$ git rebase upstream/master
+$ git rebase upstream/main
```
Making changes
--------------
-It is important that you create a new branch to make changes on and that you do not change the `master` branch (other than to rebase in changes from `upstream/master`). In this example I will assume you will be making your changes to a branch called `feature_x`. This `feature_x` branch will be created on your local repository and will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the Apache [...]
+It is important that you create a new branch to make changes on and that you do not change the `main` branch (other than to rebase in changes from `upstream/main`).
+In this example I will assume you will be making your changes to a branch called `feature_x`. This `feature_x` branch will be created on your local repository and
+will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the Apache Shiro project.
It is best practice to create a new branch each time you want to contribute to the project and only track the changes for that pull request in this branch.
@@ -42,40 +47,44 @@ $ git add .
$ git commit -a -m "descriptive commit message for your changes"
```
-> The `-b` specifies that you want to create a new branch called `feature_x`. You only specify `-b` the first time you checkout because you are creating a new branch. Once the `feature_x` branch exists, you can later switch to it with only `git checkout feature_x`.
+> The `-b` specifies that you want to create a new branch called `feature_x`. You only specify `-b` the first time you checkout because you are creating a new branch.
+> Once the `feature_x` branch exists, you can later switch to it with only `git checkout feature_x`.
-Rebase `feature_x` to include updates from `upstream/master`
+Rebase `feature_x` to include updates from `upstream/main`
------------------------------------------------------------
-It is important that you maintain an up-to-date `master` branch in your local repository. This is done by rebasing in the code changes from `upstream/master` (the official Apache Shiro project repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code.
+It is important that you maintain an up-to-date `main` branch in your local repository. This is done by rebasing in the code changes from `upstream/main`
+(the official Apache Shiro project repository) into your local repository. You will want to do this before you start working on a feature as well as right
+before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code.
This process will do the following:
-1. Checkout your local `master` branch
-2. Synchronize your local `master` branch with the `upstream/master` so you have all the latest changes from the project
+1. Checkout your local `main` branch
+2. Synchronize your local `main` branch with the `upstream/main` so you have all the latest changes from the project
3. Rebase the latest project code into your `feature_x` branch so it is up-to-date with the upstream code
``` bash
-$ git checkout master
+$ git checkout main
$ git fetch upstream
-$ git rebase upstream/master
+$ git rebase upstream/main
$ git checkout feature_x
-$ git rebase master
+$ git rebase main
```
-> Now your `feature_x` branch is up-to-date with all the code in `upstream/master`.
+> Now your `feature_x` branch is up-to-date with all the code in `upstream/main`.
Make a GitHub Pull Request to contribute your changes
-----------------------------------------------------
-When you are happy with your changes and you are ready to contribute them, you will create a Pull Request on GitHub to do so. This is done by pushing your local changes to your forked repository (default remote name is `origin`) and then initiating a pull request on GitHub.
+When you are happy with your changes and you are ready to contribute them, you will create a Pull Request on GitHub to do so. This is done by pushing your local changes
+to your forked repository (default remote name is `origin`) and then initiating a pull request on GitHub.
-> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include the latest code from `upstream/master` _before_ you do this.
+> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include the latest code from `upstream/main` _before_ you do this.
``` bash
-$ git push origin master
+$ git push origin main
$ git push origin feature_x
```
@@ -85,23 +94,25 @@ To initiate the pull request, do the following:
1. In your browser, navigate to your forked repository: [https://github.com/YOUR_ACCOUNT/shiro](https://github.com/YOUR_ACCOUNT/shiro)
2. Click the new button called '**Compare & pull request**' that showed up just above the main area in your forked repository
-3. Validate the pull request will be into the upstream `master` and will be from your `feature_x` branch
+3. Validate the pull request will be into the upstream `main` and will be from your `feature_x` branch
4. Enter a detailed description of the work you have done and then click '**Send pull request**'
-If you are requested to make modifications to your proposed changes, make the changes locally on your `feature_x` branch, re-push the `feature_x` branch to your fork. The existing pull request should automatically pick up the change and update accordingly.
+If you are requested to make modifications to your proposed changes, make the changes locally on your `feature_x` branch, re-push the `feature_x` branch to your fork.
+The existing pull request should automatically pick up the change and update accordingly.
Cleaning up after a successful pull request
-------------------------------------------
-Once the `feature_x` branch has been committed into the `upstream/master` branch, your local `feature_x` branch and the `origin/feature_x` branch are no longer needed. If you want to make additional changes, restart the process with a new branch.
+Once the `feature_x` branch has been committed into the `upstream/main` branch, your local `feature_x` branch and the `origin/feature_x` branch are no longer needed.
+If you want to make additional changes, restart the process with a new branch.
-> **IMPORTANT:** Make sure that your changes are in `upstream/master` before you delete your `feature_x` and `origin/feature_x` branches!
+> **IMPORTANT:** Make sure that your changes are in `upstream/main` before you delete your `feature_x` and `origin/feature_x` branches!
You can delete these deprecated branches with the following:
``` bash
-$ git checkout master
+$ git checkout main
$ git branch -D feature_x
$ git push origin :feature_x
```
diff --git a/pom.xml b/pom.xml
index ed757f1..0cecf8a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -44,7 +44,7 @@
<connection>scm:git:https://gitbox.apache.org/repos/asf/shiro.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/shiro.git</developerConnection>
<url>https://github.com/apache/shiro/tree/${project.scm.tag}</url>
- <tag>master</tag>
+ <tag>main</tag>
</scm>
<issueManagement>
<system>Jira</system>