Skip to content

Commit d879647

Browse files
Bump super-linter from v4 to v7 and fix all files (#2035)
1 parent 6f225ca commit d879647

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+2668
-2633
lines changed
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
name: ⛔ Support Question
33
about: See https://api-platform.com/support/ for questions about using API Platform
4-
54
---
65

7-
We use GitHub issues only to discuss about bugs and new features.
6+
# Support question
7+
8+
We use GitHub issues only to discuss bugs and new features.
89
For this kind of questions about using API Platform, please use
9-
any of the support alternatives shown in https://api-platform.com/support/
10+
any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).
1011

1112
Thanks!
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
name: 📄 Documentation issue
33
about: Report a documentation issue
4-
54
---

.github/workflows/cd.yml

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1+
---
12
name: Deploy Website
23

34
on:
45
push:
56
branches:
67
- main
7-
- '*.*'
8+
- "*.*"
9+
10+
permissions:
11+
contents: read
12+
id-token: read
13+
actions: read
14+
checks: write
15+
deployments: write
16+
pull-requests: read
817

918
jobs:
1019
deploy:
@@ -28,57 +37,52 @@ jobs:
2837
restore-keys: |
2938
${{ runner.os }}-yarn-
3039
31-
3240
- name: Setup Hugo
33-
uses: peaceiris/actions-hugo@v2
41+
uses: peaceiris/actions-hugo@v3
3442
with:
35-
hugo-version: '0.134.2'
43+
hugo-version: "0.134.2"
3644
extended: true
3745

3846
- name: Install php
3947
uses: shivammathur/setup-php@v2
4048
with:
41-
php-version: '8.2'
49+
php-version: "8.2"
4250
tools: phive
4351

4452
- name: Auth gcloud
45-
uses: google-github-actions/auth@v1
53+
uses: google-github-actions/auth@v2
4654
with:
4755
credentials_json: ${{ secrets.BUCKET_CREDS }}
48-
49-
- name: 'Set up Cloud SDK'
50-
uses: 'google-github-actions/setup-gcloud@v1'
56+
57+
- name: Set up Cloud SDK
58+
uses: google-github-actions/setup-gcloud@v2
5159

5260
- name: Clone website
53-
uses: actions/checkout@v2
61+
uses: actions/checkout@v4
5462
with:
5563
repository: api-platform/docs-website
5664
path: docs-website
65+
5766
- name: Install javascript packages
5867
working-directory: docs-website
5968
run: npm install
69+
6070
- name: Fetch API Platform docs
6171
working-directory: docs-website
6272
run: tools/get-docs.sh
73+
6374
- name: Fetch API Platform references and guides
6475
working-directory: docs-website
6576
run: tools/get-core-docs.sh
66-
- name: Build menu
77+
78+
- name: Build menu
6779
working-directory: docs-website
6880
run: node tools/menu.mjs
81+
6982
- name: Hugo
7083
working-directory: docs-website
7184
run: hugo --minify
85+
7286
- name: Deploy
7387
working-directory: docs-website
7488
run: gsutil -q -m rsync -d -r ./public gs://api-platform-website-v3/
75-
# This need to move to website
76-
# env:
77-
# GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
78-
# NODE_OPTIONS: --openssl-legacy-provider
79-
# - name: Deploy
80-
# uses: peaceiris/actions-gh-pages@v3
81-
# with:
82-
# github_token: ${{ secrets.GITHUB_TOKEN }}
83-
# publish_dir: ./public
84-
# cname: api-platform.com

.github/workflows/ci.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
---
12
name: Lint
23

34
on:
45
push:
56
pull_request:
67

7-
permissions: {}
8+
permissions:
9+
contents: read
810

911
jobs:
1012
build:
@@ -23,12 +25,12 @@ jobs:
2325
fetch-depth: 0
2426

2527
- name: Lint
26-
uses: github/super-linter/slim@v4
28+
uses: super-linter/super-linter/slim@v7
2729
env:
28-
VALIDATE_ALL_CODEBASE: false
2930
VALIDATE_EDITORCONFIG: false
3031
VALIDATE_JSCPD: false
31-
DEFAULT_BRANCH: "4.0"
32+
VALIDATE_MARKDOWN_PRETTIER: false
33+
DEFAULT_BRANCH: "origin/4.0"
3234
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3335

3436
- uses: actions/cache@v4

.markdownlint.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
MD013:
23
line_length: 400
34
no-inline-html:

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ To have your code integrated in the API Platform documentation project, there ar
88

99
Before submitting your issue:
1010

11-
* Check if the bug is not already reported!
12-
* A clear title to resume the issue
13-
* A description of the workflow needed to reproduce the bug
11+
- Check if the bug is not already reported!
12+
- A clear title to resume the issue
13+
- A description of the workflow needed to reproduce the bug
1414

1515
> [!NOTE]
1616
> Don't hesitate giving as much information as you can.
@@ -24,13 +24,13 @@ By contributing to this project, you agree to abide by our [Code of Conduct](htt
2424
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
2525

2626
2. Clone the forked repository to your local machine:
27-
```bash
28-
git clone https://github.com/your-username/repository-name.git
29-
```
27+
```bash
28+
git clone https://github.com/your-username/repository-name.git
29+
```
3030
3. Create a new branch for your contribution:
31-
```bash
32-
git switch -c docs-your-branch-name
33-
```
31+
```bash
32+
git switch -c docs-your-branch-name
33+
```
3434
4. Commit and push your changes
3535
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
3636
See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).

0 commit comments

Comments
 (0)