actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-24 17:50:58 -05:00
Code Issues Projects Releases Packages Wiki Activity

Follow up with several more documentation and automation renames for the org move from github to super-linter (#4543)

Browse source 
* move from github org to super-linter org

* rename to super-linter org

* rename to super-linter org

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter and remove dockerhub reference

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rm dockerhub section link
This commit is contained in:
Zack Koppert 2023-08-17 08:12:11 -07:00 committed by GitHub
parent 35efaac1c3
commit da4dd08cd6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 58 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.automation/cleanup-docker.sh
View file

@ -63,7 +63,7 @@ ValidateInput() {
# No repo was pulled # No repo was pulled
error "Failed to get [IMAGE_REPO]!" error "Failed to get [IMAGE_REPO]!"
fatal "[${IMAGE_REPO}]" fatal "[${IMAGE_REPO}]"
elif [[ ${IMAGE_REPO} == "github/super-linter" ]]; then elif [[ ${IMAGE_REPO} == "super-linter/super-linter" ]]; then
# Found our main repo # Found our main repo
info "Successfully found:[IMAGE_REPO], value:[${IMAGE_REPO}]" info "Successfully found:[IMAGE_REPO], value:[${IMAGE_REPO}]"
else else

2
.automation/test/go.mod
View file

@ -1,4 +1,4 @@
module github.com/github/super-linter module github.com/super-linter/super-linter
go 1.17 go 1.17

2
.automation/validate-docker-labels.sh
View file

@ -13,7 +13,7 @@
IMAGE="${1}" # Image of the super-linter we build IMAGE="${1}" # Image of the super-linter we build
BUILD_REVISION="${GITHUB_SHA}" # GitHub Sha BUILD_REVISION="${GITHUB_SHA}" # GitHub Sha
BUILD_VERSION="${GITHUB_SHA}" # Version of the container BUILD_VERSION="${GITHUB_SHA}" # Version of the container
ORG_REPO="github/super-linter" # Org/repo ORG_REPO="super-linter/super-linter" # Org/repo
REGISTRY='ghcr.io' # Docker Registry REGISTRY='ghcr.io' # Docker Registry
((LOG_TRACE = LOG_DEBUG = LOG_VERBOSE = LOG_NOTICE = LOG_WARN = LOG_ERROR = "true")) # Enable all loging ((LOG_TRACE = LOG_DEBUG = LOG_VERBOSE = LOG_NOTICE = LOG_WARN = LOG_ERROR = "true")) # Enable all loging
ERROR=0 # Error count ERROR=0 # Error count

2
.devcontainer/devcontainer.json
View file

@ -1,7 +1,7 @@
{ {
"name": "Super-Linter", "name": "Super-Linter",
"context": "..", "context": "..",
"image": "ghcr.io/github/super-linter:latest", "image": "ghcr.io/super-linter/super-linter:latest",
"extensions": [ "extensions": [
"github.vscode-pull-request-github", "github.vscode-pull-request-github",
"rogalmic.bash-debug", "rogalmic.bash-debug",

6
.github/CONTRIBUTING.md vendored
View file

@ -62,6 +62,6 @@ If you are the current maintainer of this action you can create releases from th
- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) - [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
- [GitHub Help](https://docs.github.com/en) - [GitHub Help](https://docs.github.com/en)
[pulls]: https://github.com/github/super-linter/pulls [pulls]: https://github.com/super-linter/super-linter/pulls
[pr]: https://github.com/github/super-linter/compare [pr]: https://github.com/super-linter/super-linter/compare
[fork]: https://github.com/github/super-linter/fork [fork]: https://github.com/super-linter/super-linter/fork

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -31,7 +31,7 @@ docker run \
-e MULTI_STATUS=false \ -e MULTI_STATUS=false \
-e VALIDATE_ALL_CODEBASE=true \ -e VALIDATE_ALL_CODEBASE=true \
-v $(pwd):/tmp/lint \ -v $(pwd):/tmp/lint \
ghcr.io/github/super-linter:v3.13.5 ghcr.io/super-linter/super-linter:v3.13.5
--> -->
1. Go to '...' 1. Go to '...'

2
.github/ISSUE_TEMPLATE/feature_request.md vendored
View file

@ -20,4 +20,4 @@ A clear and concise description of any alternative solutions or features you've
Add any other context or screenshots about the feature request here. Add any other context or screenshots about the feature request here.
**Note** **Note**
If this is a request to add a new language, after submitting this issue check out [the wiki](https://github.com/github/super-linter/wiki/Adding-new-language-support) for more info on how to accomplish that. If this is a request to add a new language, after submitting this issue check out [the wiki](https://github.com/super-linter/super-linter/wiki/Adding-new-language-support) for more info on how to accomplish that.

12
.github/release-drafter.yml vendored
View file

@ -5,7 +5,7 @@ template: |
# Changelog # Changelog
$CHANGES $CHANGES
See details of [all code changes](https://github.com/github/super-linter/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release See details of [all code changes](https://github.com/super-linter/super-linter/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
categories: categories:
- title: '🚀 Features' - title: '🚀 Features'
@ -28,13 +28,13 @@ change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
version-resolver: version-resolver:
major: major:
labels: labels:
- 'type: breaking' - 'breaking'
minor: minor:
labels: labels:
- 'type: enhancement' - 'enhancement'
patch: patch:
labels: labels:
- 'type: bug' - 'bug'
- 'type: maintenance' - 'maintenance'
- 'type: documentation' - 'documentation'
default: patch default: patch

8
.github/workflows/ci.yml vendored
View file

@ -27,7 +27,7 @@ jobs:
fetch-depth: 0 fetch-depth: 0
- name: Update action.yml - name: Update action.yml
run: yq '.runs.image = "docker://ghcr.io/github/super-linter:${{ matrix.images.target }}"' -i action.yml run: yq '.runs.image = "docker://ghcr.io/super-linter/super-linter:${{ matrix.images.target }}"' -i action.yml
- name: Retrieve Datetime - name: Retrieve Datetime
run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> "${GITHUB_ENV}" run: echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> "${GITHUB_ENV}"
@ -45,7 +45,7 @@ jobs:
push: false push: false
secrets: | secrets: |
GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
tags: ghcr.io/github/super-linter:${{ matrix.images.target }} tags: ghcr.io/super-linter/super-linter:${{ matrix.images.target }}
target: "${{ matrix.images.target }}" target: "${{ matrix.images.target }}"
- name: Test Local Action - name: Test Local Action
@ -77,7 +77,7 @@ jobs:
-e ACTIONS_RUNNER_DEBUG=true \ -e ACTIONS_RUNNER_DEBUG=true \
-e ERROR_ON_MISSING_EXEC_BIT=true \ -e ERROR_ON_MISSING_EXEC_BIT=true \
-v "${GITHUB_WORKSPACE}:/tmp/lint" \ -v "${GITHUB_WORKSPACE}:/tmp/lint" \
"ghcr.io/github/super-linter:${tag}" "ghcr.io/super-linter/super-linter:${tag}"
env: env:
tag: ${{ matrix.images.target }} tag: ${{ matrix.images.target }}
@ -89,6 +89,6 @@ jobs:
-e ACTIONS_RUNNER_DEBUG=true \ -e ACTIONS_RUNNER_DEBUG=true \
-e ERROR_ON_MISSING_EXEC_BIT=true \ -e ERROR_ON_MISSING_EXEC_BIT=true \
-v "${GITHUB_WORKSPACE}:/tmp/lint" \ -v "${GITHUB_WORKSPACE}:/tmp/lint" \
"ghcr.io/github/super-linter:${tag}" "ghcr.io/super-linter/super-linter:${tag}"
env: env:
tag: ${{ matrix.images.target }} tag: ${{ matrix.images.target }}

8
Dockerfile
View file

@ -98,7 +98,7 @@ COPY dependencies/* /
################################################################### ###################################################################
# Install Dependencies # # Install Dependencies #
# The chown fixes broken uid/gid in ast-types-flow dependency # # The chown fixes broken uid/gid in ast-types-flow dependency #
# (see https://github.com/github/super-linter/issues/3901) # # (see https://github.com/super-linter/super-linter/issues/3901) #
################################################################### ###################################################################
RUN npm install && chown -R "$(id -u)":"$(id -g)" node_modules && bundle install RUN npm install && chown -R "$(id -u)":"$(id -g)" node_modules && bundle install
@ -281,9 +281,9 @@ LABEL com.github.actions.name="GitHub Super-Linter" \
org.opencontainers.image.revision=$BUILD_REVISION \ org.opencontainers.image.revision=$BUILD_REVISION \
org.opencontainers.image.version=$BUILD_VERSION \ org.opencontainers.image.version=$BUILD_VERSION \
org.opencontainers.image.authors="GitHub DevOps <github_devops@github.com>" \ org.opencontainers.image.authors="GitHub DevOps <github_devops@github.com>" \
org.opencontainers.image.url="https://github.com/github/super-linter" \ org.opencontainers.image.url="https://github.com/super-linter/super-linter" \
org.opencontainers.image.source="https://github.com/github/super-linter" \ org.opencontainers.image.source="https://github.com/super-linter/super-linter" \
org.opencontainers.image.documentation="https://github.com/github/super-linter" \ org.opencontainers.image.documentation="https://github.com/super-linter/super-linter" \
org.opencontainers.image.vendor="GitHub" \ org.opencontainers.image.vendor="GitHub" \
org.opencontainers.image.description="Lint your code base with GitHub Actions" org.opencontainers.image.description="Lint your code base with GitHub Actions"

8
Makefile
View file

@ -75,16 +75,16 @@ SUPER_LINTER_TEST_CONTINER_URL := ''
DOCKERFILE := '' DOCKERFILE := ''
IMAGE := '' IMAGE := ''
ifeq ($(IMAGE),slim) ifeq ($(IMAGE),slim)
SUPER_LINTER_TEST_CONTINER_URL := "ghcr.io/github/super-linter:slim" SUPER_LINTER_TEST_CONTINER_URL := "ghcr.io/super-linter/super-linter:slim"
IMAGE := "slim" IMAGE := "slim"
else else
SUPER_LINTER_TEST_CONTINER_URL := "ghcr.io/github/super-linter:standard" SUPER_LINTER_TEST_CONTINER_URL := "ghcr.io/super-linter/super-linter:standard"
IMAGE := "standard" IMAGE := "standard"
endif endif
.PHONY: inspec .PHONY: inspec
inspec: inspec-check ## Run InSpec tests inspec: inspec-check ## Run InSpec tests
LOCAL_IMAGE="$$(docker images $(SUPER_LINTER_TEST_CONTINER_URL) |grep 'ghcr.io/github/super-linter')"; \ LOCAL_IMAGE="$$(docker images $(SUPER_LINTER_TEST_CONTINER_URL) |grep 'ghcr.io/super-linter/super-linter')"; \
if [ "$$?" -ne 0 ]; then docker build -t $(SUPER_LINTER_TEST_CONTINER_URL) -f Dockerfile .; fi && \ if [ "$$?" -ne 0 ]; then docker build -t $(SUPER_LINTER_TEST_CONTINER_URL) -f Dockerfile .; fi && \
DOCKER_CONTAINER_STATE="$$(docker inspect --format "{{.State.Running}}" "$(SUPER_LINTER_TEST_CONTAINER_NAME)" 2>/dev/null || echo "")"; \ DOCKER_CONTAINER_STATE="$$(docker inspect --format "{{.State.Running}}" "$(SUPER_LINTER_TEST_CONTAINER_NAME)" 2>/dev/null || echo "")"; \
if [ "$$DOCKER_CONTAINER_STATE" = "true" ]; then docker kill "$(SUPER_LINTER_TEST_CONTAINER_NAME)"; fi && \ if [ "$$DOCKER_CONTAINER_STATE" = "true" ]; then docker kill "$(SUPER_LINTER_TEST_CONTAINER_NAME)"; fi && \
@ -112,4 +112,4 @@ docker:
--build-arg BUILD_REVISION=$(shell git rev-parse --short HEAD) \ --build-arg BUILD_REVISION=$(shell git rev-parse --short HEAD) \
--build-arg BUILD_VERSION=$(shell git rev-parse --short HEAD) \ --build-arg BUILD_VERSION=$(shell git rev-parse --short HEAD) \
--secret id=GITHUB_TOKEN,env=GITHUB_TOKEN \ --secret id=GITHUB_TOKEN,env=GITHUB_TOKEN \
-t ghcr.io/github/super-linter . -t ghcr.io/super-linter/super-linter .

7
README.md
View file

@ -5,7 +5,7 @@
This repository is for the **GitHub Action** to run a **Super-Linter**. This repository is for the **GitHub Action** to run a **Super-Linter**.
It is a simple combination of various linters, written in `bash`, to help validate your source code. It is a simple combination of various linters, written in `bash`, to help validate your source code.
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/51071879604e4f319859d4daf91c68f5)](https://app.codacy.com/gh/github/super-linter/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=github/super-linter&amp;utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/51071879604e4f319859d4daf91c68f5)](https://app.codacy.com/gh/super-linter/super-linter/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=super-linter/super-linter&amp;utm_campaign=Badge_Grade)
**The end goal of this tool:** **The end goal of this tool:**
@ -32,7 +32,6 @@ It is a simple combination of various linters, written in `bash`, to help valida
- [Disabling rules](#disabling-rules) - [Disabling rules](#disabling-rules)
- [Using your own SSH key](#using-your-own-ssh-key) - [Using your own SSH key](#using-your-own-ssh-key)
- [Filter linted files](#filter-linted-files) - [Filter linted files](#filter-linted-files)
- [Docker Hub](#docker-hub)
- [Run Super-Linter outside GitHub Actions](#run-super-linter-outside-github-actions) - [Run Super-Linter outside GitHub Actions](#run-super-linter-outside-github-actions)
- [Local (troubleshooting/debugging/enhancements)](#local-troubleshootingdebuggingenhancements) - [Local (troubleshooting/debugging/enhancements)](#local-troubleshootingdebuggingenhancements)
- [Azure](#azure) - [Azure](#azure)
@ -525,10 +524,6 @@ And this file is considered not generated:
echo "@generated" # @not-generated echo "@generated" # @not-generated
``` ```
## Docker Hub
The **Docker** container that is built from this repository is located at [github/super-linter](https://hub.docker.com/r/github/super-linter)
## Run Super-Linter outside GitHub Actions ## Run Super-Linter outside GitHub Actions
### Local (troubleshooting/debugging/enhancements) ### Local (troubleshooting/debugging/enhancements)

2
TEMPLATES/linter.yml
View file

@ -57,7 +57,7 @@ jobs:
# Run Linter against code base # # Run Linter against code base #
################################ ################################
- name: Lint Code Base - name: Lint Code Base
uses: github/super-linter@v5 uses: super-linter/super-linter@v5
env: env:
VALIDATE_ALL_CODEBASE: false VALIDATE_ALL_CODEBASE: false
# Change to 'master' if your main branch differs # Change to 'master' if your main branch differs

2
action.yml
View file

@ -8,5 +8,5 @@ runs:
branding: branding:
icon: 'check-square' icon: 'check-square'
color: 'white' color: 'white'
# You can view https://github.com/github/super-linter#environment-variables # You can view https://github.com/super-linter/super-linter#environment-variables
# to see a comprehensive list of all environment variables that can be passed # to see a comprehensive list of all environment variables that can be passed

6
docs/disabling-linters.md
View file

@ -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. 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 repository](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. To run with your own configuration for a linter, copy the relevant [`TEMPLATE` configuration file for the linter you are using from this repository](https://github.com/super-linter/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/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. 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/super-linter/super-linter/blob/main/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [stylelint for CSS](https://github.com/super-linter/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 repository, 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. Where a configuration file exists in your repository, 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.
@ -12,4 +12,4 @@ It is possible to have custom configurations for some linters, and continue to u
For some linters it is also possible to override rules on a case by case level with directives in your code. Where this is possible we try to note how to do this in the specific linter sections below, but the official linter documentation will likely give more detail on this. For some linters it is also possible to override rules on a case by case level with directives in your code. Where this is possible we try to note how to do this in the specific linter sections below, but the official linter documentation will likely give more detail on this.
**NOTE: Please view each linters source and web page from the [Supported Linters README](https://github.com/github/super-linter#supported-linters) to see additional information on how to configure, disable, or tune additional rules.** **NOTE: Please view each linters source and web page from the [Supported Linters README](https://github.com/super-linter/super-linter#supported-linters) to see additional information on how to configure, disable, or tune additional rules.**

22
docs/release-process.md
View file

@ -1,28 +1,28 @@
# Creating GitHub Super-Linter Release # Creating GitHub Super-Linter Release
The Process to create a `Release` of the **GitHub/Super-Linter** is as follows: The Process to create a `Release` of the **super-linter/super-linter** is as follows:
- Every push to `master/main` triggers a build and deploy of the **GitHub/Super-linter** - Every push to `master/main` triggers a build and deploy of the **super-linter/super-linter**
- This creates the following images: - This creates the following images:
- `github/super-linter:latest` - `super-linter/super-linter:latest`
- `github/super-linter:slim-latest` - `super-linter/super-linter:slim-latest`
- This also causes the `Release drafter` action to update a new draft Release - This also causes the `Release drafter` action to update a new draft Release
When an *Admin* wants to create a Release, the process is as follows: When an *Admin* wants to create a Release, the process is as follows:
- The *Admin* pushes an update to `master/main` and updates the `action.yml` to point to the next **Release** version - The *Admin* pushes an update to `master/main` and updates the `action.yml` to point to the next **Release** version
- Example: `image: 'docker://ghcr.io/github/super-linter:v4.6.2'` becomes: `image: 'docker://ghcr.io/github/super-linter:v4.6.3'` - Example: `image: 'docker://ghcr.io/super-linter/super-linter:v4.6.2'` becomes: `image: 'docker://ghcr.io/super-linter/super-linter:v4.6.3'`
- Then the *admin* can go to the Release page and update the current `draft Release` - Then the *admin* can go to the Release page and update the current `draft Release`
- The *Admin* will set the correct version strings, and update any additional information in the current `draft Release` - The *Admin* will set the correct version strings, and update any additional information in the current `draft Release`
- Once the *Admin* is ready, they will select **Publish Release** - Once the *Admin* is ready, they will select **Publish Release**
- This triggers the **GitHub Actions** to take the current codebase, and build the containers, and deploy to their locations - This triggers the **GitHub Actions** to take the current codebase, and build the containers, and deploy to their locations
- This creates and pushes the following container images: - This creates and pushes the following container images:
- `github/super-linter:latest` - `super-linter/super-linter:latest`
- `github/super-linter:v4` - `super-linter/super-linter:v4`
- `github/super-linter:v4.6.3` - `super-linter/super-linter:v4.6.3`
- `github/super-linter:slim-latest` - `super-linter/super-linter:slim-latest`
- `github/super-linter:slim-v4` - `super-linter/super-linter:slim-v4`
- `github/super-linter:slim-v4.6.3` - `super-linter/super-linter:slim-v4.6.3`
- This also updates the `latest` and `vMAJOR` Git tags to point to the same commit that the release Git tag is pointing at. - This also updates the `latest` and `vMAJOR` Git tags to point to the same commit that the release Git tag is pointing at.
- At this point, the Release is complete and images are available for general consumption - At this point, the Release is complete and images are available for general consumption

14
docs/run-linter-locally.md
View file

@ -17,14 +17,14 @@ 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 github/super-linter:latest` - `docker pull super-linter/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 -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase:/tmp/lint github/super-linter` - `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase:/tmp/lint super-linter/super-linter`
- To run against a single file you can use: `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase/file:/tmp/lint/file github/super-linter` - To run against a single file you can use: `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase/file:/tmp/lint/file super-linter/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:** If you want to override the `/tmp/lint` folder, you can set the `DEFAULT_WORKSPACE` environment variable to point to the folder you'd prefer to scan. - **NOTE:** If you want to override the `/tmp/lint` folder, you can set the `DEFAULT_WORKSPACE` environment variable to point to the folder you'd prefer to scan.
- **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
@ -57,7 +57,7 @@ This always runs the local docker based linting.
docker run --rm \ docker run --rm \
-e RUN_LOCAL=true \ -e RUN_LOCAL=true \
--env-file ".github/super-linter.env" \ --env-file ".github/super-linter.env" \
-v "$PWD":/tmp/lint github/super-linter:v5 -v "$PWD":/tmp/lint super-linter/super-linter:v5
``` ```
### scripts/test ### scripts/test
@ -91,7 +91,7 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- run: cat .github/super-linter.env >> "$GITHUB_ENV" - run: cat .github/super-linter.env >> "$GITHUB_ENV"
- name: Lint Code Base - name: Lint Code Base
uses: github/super-linter@v5 uses: super-linter/super-linter@v5
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEFAULT_BRANCH: develop DEFAULT_BRANCH: develop
@ -103,9 +103,9 @@ jobs:
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 github/super-linter` - `docker run -it --entrypoint /bin/bash super-linter/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
If you find a _bug_ or _issue_, please open a **GitHub** issue at: [github/super-linter/issues](https://github.com/github/super-linter/issues) If you find a _bug_ or _issue_, please open a **GitHub** issue at: [super-linter/super-linter/issues](https://github.com/super-linter/super-linter/issues)

2
lib/functions/buildFileList.sh
View file

@ -12,7 +12,7 @@
#### Function BuildFileList #################################################### #### Function BuildFileList ####################################################
function IssueHintForFullGitHistory() { function IssueHintForFullGitHistory() {
info "Check that you have the full git history, the checkout is not shallow, etc" info "Check that you have the full git history, the checkout is not shallow, etc"
info "See https://github.com/github/super-linter#example-connecting-github-action-workflow" info "See https://github.com/super-linter/super-linter#example-connecting-github-action-workflow"
} }
################################################################################ ################################################################################

2
lib/linter.sh
View file

@ -431,7 +431,7 @@ Header() {
info "---------------------------------------------" info "---------------------------------------------"
info "---------------------------------------------" info "---------------------------------------------"
info "The Super-Linter source code can be found at:" info "The Super-Linter source code can be found at:"
info " - https://github.com/github/super-linter" info " - https://github.com/super-linter/super-linter"
info "---------------------------------------------" info "---------------------------------------------"
} }
################################################################################ ################################################################################

8
slim/README.md
View file

@ -2,14 +2,14 @@
The **GitHub Super-Linter** maintains `two` major images: The **GitHub Super-Linter** maintains `two` major images:
- `github/super-linter:v5` - `super-linter/super-linter:v5`
- `github/super-linter:slim-v5` - `super-linter/super-linter:slim-v5`
In order to help users pull this image more naturally, the `action.yml` in this directory can help users pull the `slim image`. In order to help users pull this image more naturally, the `action.yml` in this directory can help users pull the `slim image`.
## Slim Image ## Slim Image
The slim `github/super-linter:slim-v5` comes with all supported linters but removes the following: The slim `super-linter/super-linter:slim-v5` comes with all supported linters but removes the following:
- `rust` linters - `rust` linters
- `dotenv` linters - `dotenv` linters
@ -26,7 +26,7 @@ Example usage:
# Run Linter against code base # # Run Linter against code base #
################################ ################################
- name: Lint Code Base - name: Lint Code Base
uses: github/super-linter/slim@v5 uses: super-linter/super-linter/slim@v5
env: env:
VALIDATE_ALL_CODEBASE: false VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: main DEFAULT_BRANCH: main

2
slim/action.yml
View file

@ -8,5 +8,5 @@ runs:
branding: branding:
icon: 'check-square' icon: 'check-square'
color: 'white' color: 'white'
# You can view https://github.com/github/super-linter#environment-variables # You can view https://github.com/super-linter/super-linter#environment-variables
# to see a comprehensive list of all environment variables that can be passed # to see a comprehensive list of all environment variables that can be passed