Skip to content

Commit 59fac79

Browse files
Switch name of organization to super-linter (super-linter#4152)
* Switch name of organization to super-linter * Add notice * Add year Co-authored-by: Cory Calahan <[email protected]> --------- Co-authored-by: Cory Calahan <[email protected]>
1 parent 2f0d37c commit 59fac79

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
**NOTICE**: If your use of the super-linter action failed around April 26th, 2023, we changed the organization name from `github` to `super-linter` so you will need to update your references to this action from `github/super-linter` to `super-linter/super-linter`.
2+
<hr>
13
# Super-Linter
24

35
This repository is for the **GitHub Action** to run a **Super-Linter**.
@@ -216,20 +218,20 @@ After further investigation, we were able to see that a few linters were very di
216218
This allows users to choose which **Super-Linter** they want to run and potentially speed up their build time.
217219
The available images:
218220

219-
- `github/super-linter:v5`
220-
- `github/super-linter:slim-v5`
221+
- `super-linter/super-linter:v5`
222+
- `super-linter/super-linter:slim-v5`
221223

222224
#### Standard Image
223225

224-
The standard `github/super-linter:v5` comes with all supported linters.
226+
The standard `super-linter/super-linter:v5` comes with all supported linters.
225227
Example usage:
226228

227229
```yml
228230
################################
229231
# Run Linter against code base #
230232
################################
231233
- name: Lint Code Base
232-
uses: github/super-linter@v5
234+
uses: super-linter/super-linter@v5
233235
env:
234236
VALIDATE_ALL_CODEBASE: false
235237
DEFAULT_BRANCH: master
@@ -238,7 +240,7 @@ Example usage:
238240
239241
#### Slim Image
240242
241-
The slim `github/super-linter:slim-v5` comes with all supported linters but removes the following:
243+
The slim `super-linter/super-linter:slim-v5` comes with all supported linters but removes the following:
242244

243245
- `rust` linters
244246
- `dotenv` linters
@@ -255,7 +257,7 @@ Example usage:
255257
# Run Linter against code base #
256258
################################
257259
- name: Lint Code Base
258-
uses: github/super-linter/slim@v5
260+
uses: super-linter/super-linter/slim@v5
259261
env:
260262
VALIDATE_ALL_CODEBASE: false
261263
DEFAULT_BRANCH: master
@@ -420,15 +422,15 @@ But if you wish to select or exclude specific linters, we give you full control
420422
You can use the **GitHub** **Super-Linter** _with_ or _without_ your own personal rules sets. This allows for greater flexibility for each individual codebase. The Template rules all try to follow the standards we believe should be enabled at the basic level.
421423

422424
- Copy **any** or **all** template rules files from `TEMPLATES/` into the `.github/linters/` directory of your repository, and modify them to suit your needs.
423-
- The rules files in [this repository's `TEMPLATE` folder](https://github.com/github/super-linter/tree/main/TEMPLATES) will be used as defaults should any be omitted.
425+
- The rules files in [this repository's `TEMPLATE` folder](https://github.com/super-linter/super-linter/tree/main/TEMPLATES) will be used as defaults should any be omitted.
424426

425427
### Using your own rules files
426428

427429
If your repository contains your own rules files that live outside of a `.github/linters/` directory, you will have to tell Super-Linter where your rules files are located in your repository, and what their filenames are. To learn more, see [Using your own rules files](docs/using-rules-files.md).
428430

429431
### Disabling rules
430432

431-
If you need to disable certain _rules_ and _functionality_, you can view [Disable Rules](https://github.com/github/super-linter/blob/main/docs/disabling-linters.md)
433+
If you need to disable certain _rules_ and _functionality_, you can view [Disable Rules](https://github.com/super-linter/super-linter/blob/main/docs/disabling-linters.md)
432434

433435
### Using your own SSH key
434436

@@ -487,7 +489,7 @@ jobs:
487489
# Run Linter against code base #
488490
################################
489491
- name: Lint Code Base
490-
uses: github/super-linter@v5
492+
uses: super-linter/super-linter@v5
491493
env:
492494
VALIDATE_ALL_CODEBASE: false
493495
DEFAULT_BRANCH: master
@@ -533,7 +535,7 @@ The **Docker** container that is built from this repository is located at [githu
533535

534536
### Local (troubleshooting/debugging/enhancements)
535537

536-
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/main/docs/run-linter-locally.md)
538+
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/super-linter/super-linter/blob/main/docs/run-linter-locally.md)
537539

538540
Check out the [note](#how-it-works) in **How it Works** to understand more about the **Super-Linter** linting locally versus via continuous integration.
539541

@@ -560,7 +562,7 @@ Once found, it will load the certificate contents to a file, and to the trust st
560562

561563
```yml
562564
- name: Lint Code Base
563-
uses: github/super-linter@v5
565+
uses: super-linter/super-linter@v5
564566
env:
565567
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
566568
SSL_CERT_SECRET: ${{ secrets.ROOT_CA }}
@@ -576,10 +578,10 @@ Below are a list of the known limitations for the **GitHub Super-Linter**:
576578

577579
## How to contribute
578580

579-
If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/main/.github/CONTRIBUTING.md)
581+
If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/super-linter/super-linter/blob/main/.github/CONTRIBUTING.md)
580582

581583
---
582584

583585
### License
584586

585-
- [MIT License](https://github.com/github/super-linter/blob/main/LICENSE)
587+
- [MIT License](https://github.com/super-linter/super-linter/blob/main/LICENSE)

0 commit comments

Comments
 (0)