Skip to content

Commit f40764d

Browse files
authored
chore(docs): Update GitHub Actions linter configuration (#265)
* Update GitHub Actions linter configuration The default branch is now called `main` in the example * docs: Update GitHub Actions linter configuration
1 parent 496a657 commit f40764d

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -317,27 +317,38 @@ Then [install pre-commit](https://pre-commit.com/#installation) and initialize t
317317
To do so, create the file `.github/workflows/linter.yml` in your repository:
318318
```yaml
319319
---
320-
name: Lint Code Base
320+
name: Lint
321321
322-
on:
323-
push:
324-
pull_request:
325-
branches: [master]
322+
on: # yamllint disable-line rule:truthy
323+
push: null
324+
pull_request: null
325+
326+
permissions: {}
326327
327328
jobs:
328329
build:
329-
name: Lint Code Base
330+
name: Lint
330331
runs-on: ubuntu-latest
331332
333+
permissions:
334+
contents: read
335+
packages: read
336+
# To report GitHub Actions status checks
337+
statuses: write
332338
steps:
333-
- name: Checkout Code
334-
uses: actions/checkout@v2
339+
- name: Checkout code
340+
uses: actions/checkout@v5
341+
with:
342+
# super-linter needs the full git history to get the
343+
# list of files that changed across commits
344+
fetch-depth: 0
345+
persist-credentials: false
335346
336347
- name: Lint Code Base
337-
uses: github/super-linter@v3
348+
uses: super-linter/super-linter@v8.2.1
338349
env:
339350
VALIDATE_ALL_CODEBASE: false
340-
DEFAULT_BRANCH: master
351+
DEFAULT_BRANCH: main
341352
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
342353
343354
VALIDATE_SNAKEMAKE_SNAKEFMT: true

0 commit comments

Comments
 (0)