mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-24 23:21:12 -05:00
Merge branch 'master' into staging
This commit is contained in:
commit
0390ed63ea
12 changed files with 29 additions and 29 deletions
|
@ -16,7 +16,7 @@
|
||||||
###########
|
###########
|
||||||
# Globals #
|
# Globals #
|
||||||
###########
|
###########
|
||||||
GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # Github Workspace
|
GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # GitHub Workspace
|
||||||
DOCKER_USERNAME="${DOCKER_USERNAME}" # Username to login to DockerHub
|
DOCKER_USERNAME="${DOCKER_USERNAME}" # Username to login to DockerHub
|
||||||
DOCKER_PASSWORD="${DOCKER_PASSWORD}" # Password to login to DockerHub
|
DOCKER_PASSWORD="${DOCKER_PASSWORD}" # Password to login to DockerHub
|
||||||
IMAGE_REPO="${IMAGE_REPO}" # Image repo to upload the image
|
IMAGE_REPO="${IMAGE_REPO}" # Image repo to upload the image
|
||||||
|
@ -32,7 +32,7 @@ Header()
|
||||||
{
|
{
|
||||||
echo ""
|
echo ""
|
||||||
echo "-------------------------------------------------------"
|
echo "-------------------------------------------------------"
|
||||||
echo "----- Github Actions remove image from DockerHub ------"
|
echo "----- GitHub Actions remove image from DockerHub ------"
|
||||||
echo "-------------------------------------------------------"
|
echo "-------------------------------------------------------"
|
||||||
echo ""
|
echo ""
|
||||||
}
|
}
|
||||||
|
|
|
@ -62,7 +62,7 @@ core_expire_sessions: "false"
|
||||||
core_package_version: "null"
|
core_package_version: "null"
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Default Github Vars #
|
# Default GitHub Vars #
|
||||||
#######################
|
#######################
|
||||||
github_ssl_enabled: "true"
|
github_ssl_enabled: "true"
|
||||||
github_ssl_tls_mode: "tlsv12"
|
github_ssl_tls_mode: "tlsv12"
|
||||||
|
|
|
@ -74,7 +74,7 @@
|
||||||
###################################
|
###################################
|
||||||
# Set the GHE Admin Password fact #
|
# Set the GHE Admin Password fact #
|
||||||
###################################
|
###################################
|
||||||
- name: Set the Github Admin password fact
|
- name: Set the GitHub Admin password fact
|
||||||
set_fact:
|
set_fact:
|
||||||
github_admin_password: "{{ github_admin_password }}"
|
github_admin_password: "{{ github_admin_password }}"
|
||||||
|
|
||||||
|
|
|
@ -89,7 +89,7 @@ def delete_label(label_id):
|
||||||
Delete the specified label
|
Delete the specified label
|
||||||
:param label_id: Label's node id.
|
:param label_id: Label's node id.
|
||||||
:type label_id: str
|
:type label_id: str
|
||||||
:return: Github API request response.
|
:return: GitHub API request response.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
query_variables = {
|
query_variables = {
|
||||||
|
|
|
@ -88,7 +88,7 @@ def delete_label(label_id):
|
||||||
Delete the specified label
|
Delete the specified label
|
||||||
:param label_id: Label's node id.
|
:param label_id: Label's node id.
|
||||||
:type label_id: str
|
:type label_id: str
|
||||||
:return: Github API request response.
|
:return: GitHub API request response.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
query_variables = {
|
query_variables = {
|
||||||
|
|
|
@ -17,7 +17,7 @@
|
||||||
###########
|
###########
|
||||||
# Globals #
|
# Globals #
|
||||||
###########
|
###########
|
||||||
GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # Github Workspace
|
GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # GitHub Workspace
|
||||||
DOCKER_USERNAME="${DOCKER_USERNAME}" # Username to login to DockerHub
|
DOCKER_USERNAME="${DOCKER_USERNAME}" # Username to login to DockerHub
|
||||||
DOCKER_PASSWORD="${DOCKER_PASSWORD}" # Password to login to DockerHub
|
DOCKER_PASSWORD="${DOCKER_PASSWORD}" # Password to login to DockerHub
|
||||||
IMAGE_REPO="${IMAGE_REPO}" # Image repo to upload the image
|
IMAGE_REPO="${IMAGE_REPO}" # Image repo to upload the image
|
||||||
|
@ -33,7 +33,7 @@ Header()
|
||||||
{
|
{
|
||||||
echo ""
|
echo ""
|
||||||
echo "-------------------------------------------------------"
|
echo "-------------------------------------------------------"
|
||||||
echo "------ Github Actions Upload image to DockerHub -------"
|
echo "------ GitHub Actions Upload image to DockerHub -------"
|
||||||
echo "-------------------------------------------------------"
|
echo "-------------------------------------------------------"
|
||||||
echo ""
|
echo ""
|
||||||
}
|
}
|
||||||
|
|
6
.github/CONTRIBUTING.md
vendored
6
.github/CONTRIBUTING.md
vendored
|
@ -40,6 +40,6 @@ If you are the current maintainer of this action:
|
||||||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
||||||
- [GitHub Help](https://help.github.com)
|
- [GitHub Help](https://help.github.com)
|
||||||
|
|
||||||
[pulls]: https://github.com/github/github-demo-stack/pulls
|
[pulls]: https://github.com/github/super-linter/pulls
|
||||||
[pr]: https://github.com/github/github-demo-stack/compare
|
[pr]: https://github.com/github/super-linter/compare
|
||||||
[fork]: https://github.com/github/github-demo-stack/fork
|
[fork]: https://github.com/github/super-linter/fork
|
||||||
|
|
|
@ -13,7 +13,7 @@ FROM python:alpine
|
||||||
# Label the instance and set maintainer #
|
# Label the instance and set maintainer #
|
||||||
#########################################
|
#########################################
|
||||||
LABEL com.github.actions.name="GitHub Super-Linter" \
|
LABEL com.github.actions.name="GitHub Super-Linter" \
|
||||||
com.github.actions.description="Lint your code base with Github Actions" \
|
com.github.actions.description="Lint your code base with GitHub Actions" \
|
||||||
com.github.actions.icon="code" \
|
com.github.actions.icon="code" \
|
||||||
com.github.actions.color="red" \
|
com.github.actions.color="red" \
|
||||||
maintainer="GitHub DevOps <github_devops@github.com>"
|
maintainer="GitHub DevOps <github_devops@github.com>"
|
||||||
|
@ -89,7 +89,7 @@ RUN wget -qO- "https://github.com/koalaman/shellcheck/releases/download/stable/s
|
||||||
#####################
|
#####################
|
||||||
# Install Go Linter #
|
# Install Go Linter #
|
||||||
#####################
|
#####################
|
||||||
ARG GO_VERSION='v1.23.7'
|
ARG GO_VERSION='v1.27.0'
|
||||||
RUN wget -O- -nvq https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s "$GO_VERSION"
|
RUN wget -O- -nvq https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s "$GO_VERSION"
|
||||||
|
|
||||||
##################
|
##################
|
||||||
|
@ -99,7 +99,7 @@ RUN curl -Ls "$(curl -Ls https://api.github.com/repos/terraform-linters/tflint/r
|
||||||
&& mv "tflint" /usr/bin/
|
&& mv "tflint" /usr/bin/
|
||||||
|
|
||||||
###########################################
|
###########################################
|
||||||
# Load GitHub Env Vars for Github Actions #
|
# Load GitHub Env Vars for GitHub Actions #
|
||||||
###########################################
|
###########################################
|
||||||
ENV GITHUB_SHA=${GITHUB_SHA} \
|
ENV GITHUB_SHA=${GITHUB_SHA} \
|
||||||
GITHUB_EVENT_PATH=${GITHUB_EVENT_PATH} \
|
GITHUB_EVENT_PATH=${GITHUB_EVENT_PATH} \
|
||||||
|
|
|
@ -27,7 +27,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
|
||||||
| **Markdown** | [markdownlint](https://github.com/igorshubovych/markdownlint-cli#readme) |
|
| **Markdown** | [markdownlint](https://github.com/igorshubovych/markdownlint-cli#readme) |
|
||||||
| **Perl** | [perl](https://pkgs.alpinelinux.org/package/edge/main/x86/perl) |
|
| **Perl** | [perl](https://pkgs.alpinelinux.org/package/edge/main/x86/perl) |
|
||||||
| **Python3** | [pylint](https://www.pylint.org/) |
|
| **Python3** | [pylint](https://www.pylint.org/) |
|
||||||
| **Ruby** | [Rubocop](https://github.com/rubocop-hq/rubocop) |
|
| **Ruby** | [RuboCop](https://github.com/rubocop-hq/rubocop) |
|
||||||
| **Shell** | [Shellcheck](https://github.com/koalaman/shellcheck) |
|
| **Shell** | [Shellcheck](https://github.com/koalaman/shellcheck) |
|
||||||
| **Terraform** | [tflint](https://github.com/terraform-linters/tflint) |
|
| **Terraform** | [tflint](https://github.com/terraform-linters/tflint) |
|
||||||
| **TypeScript** | [eslint](https://eslint.org/) [standard js](https://standardjs.com/) |
|
| **TypeScript** | [eslint](https://eslint.org/) [standard js](https://standardjs.com/) |
|
||||||
|
@ -143,7 +143,7 @@ You can use the **GitHub** **Super-Linter** *with* or *without* your own persona
|
||||||
If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)
|
If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)
|
||||||
|
|
||||||
## Docker Hub
|
## Docker Hub
|
||||||
The **Docker** container that is built from this repository is located at `https://hub.docker.com/r/admiralawkbar/super-linter`
|
The **Docker** container that is built from this repository is located at `https://hub.docker.com/r/github/super-linter`
|
||||||
|
|
||||||
## Running Super-Linter locally (troubleshooting/debugging/enhancements)
|
## Running Super-Linter locally (troubleshooting/debugging/enhancements)
|
||||||
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)
|
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)
|
||||||
|
|
|
@ -26,20 +26,20 @@ Below is examples and documentation for each language and the various methods to
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
## Ruby
|
## Ruby
|
||||||
- [Rubocop](https://github.com/rubocop-hq/rubocop)
|
- [RuboCop](https://github.com/rubocop-hq/rubocop)
|
||||||
|
|
||||||
### Rubocop Config file
|
### RuboCop Config file
|
||||||
- `.github/linters/.ruby-lint.yml`
|
- `.github/linters/.ruby-lint.yml`
|
||||||
- You can pass multiple rules and overwrite default rules
|
- You can pass multiple rules and overwrite default rules
|
||||||
- File should be located at: `.github/linters/.ruby-lint.yml`
|
- File should be located at: `.github/linters/.ruby-lint.yml`
|
||||||
- **Note:** We use the Default **GitHub** Rule set from [Rubocop-GitHub](https://github.com/github/rubocop-github)
|
- **Note:** We use the Default **GitHub** Rule set from [RuboCop-GitHub](https://github.com/github/rubocop-github)
|
||||||
|
|
||||||
### Rubocop disable single line
|
### RuboCop disable single line
|
||||||
```ruby
|
```ruby
|
||||||
method(argument) # rubocop:disable SomeRule, SomeOtherRule
|
method(argument) # rubocop:disable SomeRule, SomeOtherRule
|
||||||
```
|
```
|
||||||
|
|
||||||
### Rubocop disable code block
|
### RuboCop disable code block
|
||||||
```ruby
|
```ruby
|
||||||
# rubocop:disable
|
# rubocop:disable
|
||||||
This is a long line
|
This is a long line
|
||||||
|
@ -47,7 +47,7 @@ var="this is some other stuff"
|
||||||
# rubocop:enable
|
# rubocop:enable
|
||||||
```
|
```
|
||||||
|
|
||||||
### Rubocop disable entire file
|
### RuboCop disable entire file
|
||||||
If you need to ignore an entire file, you can update the `.github/linters/.ruby-lint.yml` to ignore certain files and locations
|
If you need to ignore an entire file, you can update the `.github/linters/.ruby-lint.yml` to ignore certain files and locations
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
|
|
|
@ -12,13 +12,13 @@ You can follow the link below on how to install and configure **Docker** on your
|
||||||
|
|
||||||
## Download the latest Super-Linter Docker container
|
## Download the latest Super-Linter Docker container
|
||||||
- Pull the latest **Docker** container down from **DockerHub**
|
- Pull the latest **Docker** container down from **DockerHub**
|
||||||
- `docker pull admiralawkbar/super-linter:latest`
|
- `docker pull github/super-linter:latest`
|
||||||
Once the container has been downloaded to your local environment, you can then begin the process, or running the container against your codebase.
|
Once the container has been downloaded to your local environment, you can then begin the process, or running the container against your codebase.
|
||||||
|
|
||||||
## Run the container Locally
|
## Run the container Locally
|
||||||
- You can run the container locally with the following **Base** flags to run your code:
|
- You can run the container locally with the following **Base** flags to run your code:
|
||||||
- `docker run -e RUN_LOCAL=true -v /path/to/local/codebase:/tmp/lint admiralawkbar/super-linter`
|
- `docker run -e RUN_LOCAL=true -v /path/to/local/codebase:/tmp/lint github/super-linter`
|
||||||
- To run against a single file you can use: `docker run -e RUN_LOCAL=true -v /path/to/local/codebase/file:/tmp/lint/file admiralawkbar/super-linter`
|
- To run against a single file you can use: `docker run -e RUN_LOCAL=true -v /path/to/local/codebase/file:/tmp/lint/file github/super-linter`
|
||||||
- **NOTE:** You need to pass the `RUN_LOCAL` flag to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint` so that the linter can pick up the code
|
- **NOTE:** You need to pass the `RUN_LOCAL` flag to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint` so that the linter can pick up the code
|
||||||
- **NOTE:** The flag:`RUN_LOCAL` will set: `VALIDATE_ALL_CODEBASE` to true. This means it will scan **all** the files in the directory you have mapped. If you want to only validate a subset of your codebase, map a folder with only the files you wish to have linted
|
- **NOTE:** The flag:`RUN_LOCAL` will set: `VALIDATE_ALL_CODEBASE` to true. This means it will scan **all** the files in the directory you have mapped. If you want to only validate a subset of your codebase, map a folder with only the files you wish to have linted
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ You can add as many **Additional** flags as needed, documented in [README.md](..
|
||||||
|
|
||||||
### Run container and gain access to the command line
|
### Run container and gain access to the command line
|
||||||
If you need to run the container locally and gain access to its command line, you can run the following command:
|
If you need to run the container locally and gain access to its command line, you can run the following command:
|
||||||
- `docker run -it --entrypoint /bin/bash admiralawkbar/super-linter`
|
- `docker run -it --entrypoint /bin/bash github/super-linter`
|
||||||
- This will drop you in the command line of the docker container for any testing or troubleshooting that may be needed.
|
- This will drop you in the command line of the docker container for any testing or troubleshooting that may be needed.
|
||||||
|
|
||||||
### Found issues
|
### Found issues
|
||||||
|
|
|
@ -168,7 +168,7 @@ Header()
|
||||||
##########
|
##########
|
||||||
echo ""
|
echo ""
|
||||||
echo "---------------------------------------------"
|
echo "---------------------------------------------"
|
||||||
echo "--- Github Actions Multi Language Linter ----"
|
echo "--- GitHub Actions Multi Language Linter ----"
|
||||||
echo "---------------------------------------------"
|
echo "---------------------------------------------"
|
||||||
echo ""
|
echo ""
|
||||||
echo "---------------------------------------------"
|
echo "---------------------------------------------"
|
||||||
|
@ -1964,9 +1964,9 @@ RunTestCases()
|
||||||
Header
|
Header
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Get Github Env Vars #
|
# Get GitHub Env Vars #
|
||||||
#######################
|
#######################
|
||||||
# Need to pull in all the Github variables
|
# Need to pull in all the GitHub variables
|
||||||
# needed to connect back and update checks
|
# needed to connect back and update checks
|
||||||
GetGitHubVars
|
GetGitHubVars
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue