From 42ac0c1f0f64cd38245e863385c993b44ab7c094 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Fri, 1 Oct 2021 12:57:26 -0700 Subject: [PATCH] switch to main branch (#2010) * switch to main branch * switch from master to main * switch default branch to main * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * switch to main branch * make comment reflect code * switch to main branch --- .automation/README.md | 2 +- .github/CONTRIBUTING.md | 2 +- .github/ISSUE_TEMPLATE/ISSUE.md | 2 +- .github/workflows/deploy-DEV-slim.yml | 8 ++++---- .github/workflows/deploy-DEV-standard.yml | 8 ++++---- .github/workflows/deploy-PROD-slim.yml | 7 +++---- .github/workflows/deploy-PROD-standard.yml | 7 +++---- .github/workflows/deploy-RELEASE-slim.yml | 6 +++--- .github/workflows/deploy-RELEASE-standard.yml | 6 +++--- .github/workflows/draft-release.yml | 13 ++++++------- .github/workflows/stack-linter.yml | 2 +- .github/workflows/trivy.yml | 2 +- docs/disabling-linters.md | 4 ++-- docs/using-rules-files.md | 2 +- slim/README.md | 2 +- 15 files changed, 35 insertions(+), 38 deletions(-) diff --git a/.automation/README.md b/.automation/README.md index cbb02f2e..bd1e5898 100644 --- a/.automation/README.md +++ b/.automation/README.md @@ -15,7 +15,7 @@ This script uses **GitHub Actions** so that when a push to the repository is com - Build the **Docker** container for **Super-Linter** using that source code - Upload the container to **DockerHub** -When the script is triggered on master, it will push with the tag:**latest** which is used by all scripting for general availability. +When the script is triggered on the main branch, it will push with the tag:**latest** which is used by all scripting for general availability. When the script is triggered in a branch, it will push with the tag:**NameOfBranch** which can be used for: - _testing_ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d49c8bb4..09044a39 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -41,7 +41,7 @@ The **Super-Linter** has _CI/CT/CD_ configured utilizing **GitHub** Actions. - The **Docker** container is then ran against the _test cases_ to validate all code sanity - `.automation/test` contains all test cases for each language that should be validated - These **GitHub** Actions utilize the Checks API and Protected Branches to help follow the SDLC -- When the Pull Request is merged to master, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase +- When the Pull Request is merged to main, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase - **Note:** The branch's **Docker** container is also removed from **DockerHub** to cleanup after itself ## Releasing diff --git a/.github/ISSUE_TEMPLATE/ISSUE.md b/.github/ISSUE_TEMPLATE/ISSUE.md index fa84f7fd..ca82066b 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE.md @@ -9,7 +9,7 @@ about: Used for creating issues about the GitHub Super-Linter ### Issue with GitHub Super-Linter --- -**Branch/Version:** Example: Master +**Branch/Version:** Example: main --- **How to Reproduce:** Example: tried to build it diff --git a/.github/workflows/deploy-DEV-slim.yml b/.github/workflows/deploy-DEV-slim.yml index 8de484ca..f36b2b09 100644 --- a/.github/workflows/deploy-DEV-slim.yml +++ b/.github/workflows/deploy-DEV-slim.yml @@ -10,15 +10,15 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +##################################### +# Start the job on all push to main # +##################################### ############################# # Start the job on all push # ############################# on: push: - branches-ignore: [master] + branches-ignore: [main] ############### # Set the Job # diff --git a/.github/workflows/deploy-DEV-standard.yml b/.github/workflows/deploy-DEV-standard.yml index c51d5c18..24ba1556 100644 --- a/.github/workflows/deploy-DEV-standard.yml +++ b/.github/workflows/deploy-DEV-standard.yml @@ -10,15 +10,15 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +##################################### +# Start the job on all push to main # +##################################### ############################# # Start the job on all push # ############################# on: push: - branches-ignore: [master] + branches-ignore: [main] ############### # Set the Job # diff --git a/.github/workflows/deploy-PROD-slim.yml b/.github/workflows/deploy-PROD-slim.yml index 8f0bfde7..668d0610 100644 --- a/.github/workflows/deploy-PROD-slim.yml +++ b/.github/workflows/deploy-PROD-slim.yml @@ -10,13 +10,12 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +##################################### +# Start the job on all push to main # +##################################### on: push: branches: - - 'master' - 'main' ############### diff --git a/.github/workflows/deploy-PROD-standard.yml b/.github/workflows/deploy-PROD-standard.yml index 22c574dc..379b96e7 100644 --- a/.github/workflows/deploy-PROD-standard.yml +++ b/.github/workflows/deploy-PROD-standard.yml @@ -10,13 +10,12 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +##################################### +# Start the job on all push to main # +##################################### on: push: branches: - - 'master' - 'main' ############### diff --git a/.github/workflows/deploy-RELEASE-slim.yml b/.github/workflows/deploy-RELEASE-slim.yml index c6cb43c7..d0e1a86e 100644 --- a/.github/workflows/deploy-RELEASE-slim.yml +++ b/.github/workflows/deploy-RELEASE-slim.yml @@ -10,9 +10,9 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +########################################### +# Start the job upon publishing a release # +########################################### on: # Start when a release is published release: diff --git a/.github/workflows/deploy-RELEASE-standard.yml b/.github/workflows/deploy-RELEASE-standard.yml index 6b1d62b5..f6f3d3c1 100644 --- a/.github/workflows/deploy-RELEASE-standard.yml +++ b/.github/workflows/deploy-RELEASE-standard.yml @@ -10,9 +10,9 @@ # https://help.github.com/en/articles/workflow-syntax-for-github-actions # -####################################### -# Start the job on all push to master # -####################################### +########################################## +# Start the job upon a published release # +########################################## on: # Start when a release is published release: diff --git a/.github/workflows/draft-release.yml b/.github/workflows/draft-release.yml index 1e7339b9..00053317 100644 --- a/.github/workflows/draft-release.yml +++ b/.github/workflows/draft-release.yml @@ -1,19 +1,18 @@ --- -########################################### -########################################### -## Draft releases on Push to master/main ## -########################################### -########################################### +#################################### +#################################### +## Draft releases on Push to main ## +#################################### +#################################### name: Release Drafter ########################### -# Start on push to master # +# Start on push to main # ########################### on: push: # branches to consider in the event; optional, defaults to all branches: - - master - main ################# diff --git a/.github/workflows/stack-linter.yml b/.github/workflows/stack-linter.yml index 7ce958e9..3272819e 100644 --- a/.github/workflows/stack-linter.yml +++ b/.github/workflows/stack-linter.yml @@ -15,7 +15,7 @@ ############################# on: push: - branches: [master] + branches: [main] pull_request: branches-ignore: [] diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 442c0572..190fc684 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -4,7 +4,7 @@ name: Container Security Scan with Trivy on: push: branches: - - master + - main pull_request: jobs: scan-container: diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md index 76cd36d8..0e26ec87 100644 --- a/docs/disabling-linters.md +++ b/docs/disabling-linters.md @@ -2,9 +2,9 @@ Linters can often require additional configuration to ensure they work with your codebase and your team's coding style, to avoid flagging false-positives. The **GitHub Super-Linter** has set up some default configurations for each linter which should work reasonably well with common code bases, but many of the linters can be configured to disable certain rules or configure the rules to ignore certain pieces of codes. -To run with your own configuration for a linter, copy the relevant [`TEMPLATE` configuration file for the linter you are using from this repo](https://github.com/github/super-linter/tree/master/TEMPLATES) into the `.github/linters/` folder in your own repository, and then edit it to modify, disable - or even add - rules and configuration to suit how you want your code checked. +To run with your own configuration for a linter, copy the relevant [`TEMPLATE` configuration file for the linter you are using from this repo](https://github.com/github/super-linter/tree/main/TEMPLATES) into the `.github/linters/` folder in your own repository, and then edit it to modify, disable - or even add - rules and configuration to suit how you want your code checked. -How the changes are made differ for each linter, and also how much the **Github Super-Linter** has decided to change the linter's defaults. So, for some linters (e.g. [pylint for python](https://github.com/github/super-linter/blob/master/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [stylelint for CSS](https://github.com/github/super-linter/blob/master/TEMPLATES/.stylelintrc.json)) the default configuration file may initially be nearly empty. And for some (e.g. StandardJS) it may not be possible to change configuration at all so there is no Template file. +How the changes are made differ for each linter, and also how much the **Github Super-Linter** has decided to change the linter's defaults. So, for some linters (e.g. [pylint for python](https://github.com/github/super-linter/blob/main/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [stylelint for CSS](https://github.com/github/super-linter/blob/main/TEMPLATES/.stylelintrc.json)) the default configuration file may initially be nearly empty. And for some (e.g. StandardJS) it may not be possible to change configuration at all so there is no Template file. Where a configuration file exists in your repo, it will be used in preference to the default one in the **GitHub Super-Linter** `TEMPLATES` directory (not in addition to it), and where one doesn't exist the `TEMPLATES` version will be used. So you should copy the complete configuration file you require to change from the `TEMPLATES` directory and not just the lines of config you want to change. diff --git a/docs/using-rules-files.md b/docs/using-rules-files.md index 0641cc97..bb405780 100644 --- a/docs/using-rules-files.md +++ b/docs/using-rules-files.md @@ -11,7 +11,7 @@ Below is an example of how to configure the ``env`` section of Super-Linter's `` ``` yaml env: VALIDATE_ALL_CODEBASE: false - DEFAULT_BRANCH: master + DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} LINTER_RULES_PATH: / diff --git a/slim/README.md b/slim/README.md index 53c088eb..45ef2b92 100644 --- a/slim/README.md +++ b/slim/README.md @@ -29,5 +29,5 @@ Example usage: uses: github/super-linter/slim@v4 env: VALIDATE_ALL_CODEBASE: false - DEFAULT_BRANCH: master + DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}