You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-13Lines changed: 15 additions & 13 deletions
Original file line number
Diff line number
Diff 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>
1
3
# Super-Linter
2
4
3
5
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
216
218
This allows users to choose which **Super-Linter** they want to run and potentially speed up their build time.
217
219
The available images:
218
220
219
-
-`github/super-linter:v5`
220
-
-`github/super-linter:slim-v5`
221
+
-`super-linter/super-linter:v5`
222
+
-`super-linter/super-linter:slim-v5`
221
223
222
224
#### Standard Image
223
225
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.
225
227
Example usage:
226
228
227
229
```yml
228
230
################################
229
231
# Run Linter against code base #
230
232
################################
231
233
- name: Lint Code Base
232
-
uses: github/super-linter@v5
234
+
uses: super-linter/super-linter@v5
233
235
env:
234
236
VALIDATE_ALL_CODEBASE: false
235
237
DEFAULT_BRANCH: master
@@ -238,7 +240,7 @@ Example usage:
238
240
239
241
#### Slim Image
240
242
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:
242
244
243
245
- `rust`linters
244
246
- `dotenv`linters
@@ -255,7 +257,7 @@ Example usage:
255
257
# Run Linter against code base #
256
258
################################
257
259
- name: Lint Code Base
258
-
uses: github/super-linter/slim@v5
260
+
uses: super-linter/super-linter/slim@v5
259
261
env:
260
262
VALIDATE_ALL_CODEBASE: false
261
263
DEFAULT_BRANCH: master
@@ -420,15 +422,15 @@ But if you wish to select or exclude specific linters, we give you full control
420
422
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.
421
423
422
424
- 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.
424
426
425
427
### Using your own rules files
426
428
427
429
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).
428
430
429
431
### Disabling rules
430
432
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)
432
434
433
435
### Using your own SSH key
434
436
@@ -487,7 +489,7 @@ jobs:
487
489
# Run Linter against code base #
488
490
################################
489
491
- name: Lint Code Base
490
-
uses: github/super-linter@v5
492
+
uses: super-linter/super-linter@v5
491
493
env:
492
494
VALIDATE_ALL_CODEBASE: false
493
495
DEFAULT_BRANCH: master
@@ -533,7 +535,7 @@ The **Docker** container that is built from this repository is located at [githu
533
535
534
536
### Local (troubleshooting/debugging/enhancements)
535
537
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)
537
539
538
540
Check out the [note](#how-it-works) in **How it Works** to understand more about the **Super-Linter** linting locally versus via continuous integration.
539
541
@@ -560,7 +562,7 @@ Once found, it will load the certificate contents to a file, and to the trust st
560
562
561
563
```yml
562
564
- name: Lint Code Base
563
-
uses: github/super-linter@v5
565
+
uses: super-linter/super-linter@v5
564
566
env:
565
567
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
566
568
SSL_CERT_SECRET: ${{ secrets.ROOT_CA }}
@@ -576,10 +578,10 @@ Below are a list of the known limitations for the **GitHub Super-Linter**:
576
578
577
579
## How to contribute
578
580
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)
0 commit comments