Skip to content

Commit

Permalink
Bump super-linter from v4 to v7 and fix all files (#2035)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinceAmstoutz authored Oct 10, 2024
1 parent 6f225ca commit d879647
Show file tree
Hide file tree
Showing 95 changed files with 2,668 additions and 2,633 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/1_Support_question.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
name: ⛔ Support Question
about: See https://api-platform.com/support/ for questions about using API Platform

---

We use GitHub issues only to discuss about bugs and new features.
# Support question

We use GitHub issues only to discuss bugs and new features.
For this kind of questions about using API Platform, please use
any of the support alternatives shown in https://api-platform.com/support/
any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).

Thanks!
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/2_Documentation_issue.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
name: 📄 Documentation issue
about: Report a documentation issue

---
46 changes: 25 additions & 21 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
---
name: Deploy Website

on:
push:
branches:
- main
- '*.*'
- "*.*"

permissions:
contents: read
id-token: read
actions: read
checks: write
deployments: write
pull-requests: read

jobs:
deploy:
Expand All @@ -28,57 +37,52 @@ jobs:
restore-keys: |
${{ runner.os }}-yarn-
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
uses: peaceiris/actions-hugo@v3
with:
hugo-version: '0.134.2'
hugo-version: "0.134.2"
extended: true

- name: Install php
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
php-version: "8.2"
tools: phive

- name: Auth gcloud
uses: google-github-actions/auth@v1
uses: google-github-actions/auth@v2
with:
credentials_json: ${{ secrets.BUCKET_CREDS }}
- name: 'Set up Cloud SDK'
uses: 'google-github-actions/setup-gcloud@v1'

- name: Set up Cloud SDK
uses: google-github-actions/setup-gcloud@v2

- name: Clone website
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
repository: api-platform/docs-website
path: docs-website

- name: Install javascript packages
working-directory: docs-website
run: npm install

- name: Fetch API Platform docs
working-directory: docs-website
run: tools/get-docs.sh

- name: Fetch API Platform references and guides
working-directory: docs-website
run: tools/get-core-docs.sh
- name: Build menu

- name: Build menu
working-directory: docs-website
run: node tools/menu.mjs

- name: Hugo
working-directory: docs-website
run: hugo --minify

- name: Deploy
working-directory: docs-website
run: gsutil -q -m rsync -d -r ./public gs://api-platform-website-v3/
# This need to move to website
# env:
# GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
# NODE_OPTIONS: --openssl-legacy-provider
# - name: Deploy
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./public
# cname: api-platform.com
10 changes: 6 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
name: Lint

on:
push:
pull_request:

permissions: {}
permissions:
contents: read

jobs:
build:
Expand All @@ -23,12 +25,12 @@ jobs:
fetch-depth: 0

- name: Lint
uses: github/super-linter/slim@v4
uses: super-linter/super-linter/slim@v7
env:
VALIDATE_ALL_CODEBASE: false
VALIDATE_EDITORCONFIG: false
VALIDATE_JSCPD: false
DEFAULT_BRANCH: "4.0"
VALIDATE_MARKDOWN_PRETTIER: false
DEFAULT_BRANCH: "origin/4.0"
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- uses: actions/cache@v4
Expand Down
1 change: 1 addition & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
MD013:
line_length: 400
no-inline-html:
Expand Down
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ To have your code integrated in the API Platform documentation project, there ar

Before submitting your issue:

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

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

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

0 comments on commit d879647

Please sign in to comment.