Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Change offensive terms #202

Open
bhamail opened this issue Aug 12, 2020 · 1 comment
Open

[FEATURE] Change offensive terms #202

bhamail opened this issue Aug 12, 2020 · 1 comment

Comments

@bhamail
Copy link
Contributor

bhamail commented Aug 12, 2020

Replace use of terms that may be offensive, e.g. whitelist

Related: keep an eye out for changing names of source code branches, e.g. master to main

cc @bhamail / @DarthHater / @allenhsieh / @ken-duck

@bhamail
Copy link
Contributor Author

bhamail commented Sep 24, 2020

Not intending to single out auditjs, but I'm gonna use this Issue to collect some notes on converting projects to use a "main" branch instead of a "master" branch. Hopefully this is of use to others. Please add your learnings too!


Renaming master branch to main

Followed these steps to create new main branch and set as the default: https://www.git-tower.com/learn/git/faq/git-rename-master-to-main/

In addition to the steps in the article, I also ran into a need to change the Branch Protection Rules:
BranchProtection

Also, for any python semantic release users: sonatype-nexus-community/jake@26f215d

Update README.md links that refer to master to refer to main, like logos, images, etc.

  • CircleCI - so far our configs for CircleCI have not required any sort of changes. If your config.yml mentions the master branch by name for any reason, you might need to make changes, but so far, we've not needed any changes. Noice!

  • Jenkins (internal builds) - So far, two main steps:

    1. In Jenkins Web UI config, change Pipeline "Branches to build" -> "Branch Specifier (blank for 'any')" from:
      */master
      to:
      */main

    image

    1. In the Jenkinsfile, change the "dockerizedBuildPipeline" to include a deployBranch value to override the current default:

    image

    Failure to do this step will cause the Jenkins build to "skip" the "Deploy" and "Post Deploy" steps, but will not cause an obvious build failure. Such a case is shown below:

    image

Please add any new steps you find here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants