mirror of
https://github.com/super-linter/super-linter.git
synced 2024-12-22 12:42:09 -05:00
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
This commit is contained in:
parent
fd9c4286d3
commit
42ac0c1f0f
15 changed files with 35 additions and 38 deletions
|
@ -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_
|
||||
|
|
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
|
@ -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
|
||||
|
|
2
.github/ISSUE_TEMPLATE/ISSUE.md
vendored
2
.github/ISSUE_TEMPLATE/ISSUE.md
vendored
|
@ -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
|
||||
|
|
8
.github/workflows/deploy-DEV-slim.yml
vendored
8
.github/workflows/deploy-DEV-slim.yml
vendored
|
@ -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 #
|
||||
|
|
8
.github/workflows/deploy-DEV-standard.yml
vendored
8
.github/workflows/deploy-DEV-standard.yml
vendored
|
@ -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 #
|
||||
|
|
7
.github/workflows/deploy-PROD-slim.yml
vendored
7
.github/workflows/deploy-PROD-slim.yml
vendored
|
@ -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'
|
||||
|
||||
###############
|
||||
|
|
7
.github/workflows/deploy-PROD-standard.yml
vendored
7
.github/workflows/deploy-PROD-standard.yml
vendored
|
@ -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'
|
||||
|
||||
###############
|
||||
|
|
6
.github/workflows/deploy-RELEASE-slim.yml
vendored
6
.github/workflows/deploy-RELEASE-slim.yml
vendored
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
13
.github/workflows/draft-release.yml
vendored
13
.github/workflows/draft-release.yml
vendored
|
@ -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
|
||||
|
||||
#################
|
||||
|
|
2
.github/workflows/stack-linter.yml
vendored
2
.github/workflows/stack-linter.yml
vendored
|
@ -15,7 +15,7 @@
|
|||
#############################
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches-ignore: []
|
||||
|
||||
|
|
2
.github/workflows/trivy.yml
vendored
2
.github/workflows/trivy.yml
vendored
|
@ -4,7 +4,7 @@ name: Container Security Scan with Trivy
|
|||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
pull_request:
|
||||
jobs:
|
||||
scan-container:
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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: /
|
||||
|
|
|
@ -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 }}
|
||||
|
|
Loading…
Reference in a new issue