Skip to content

Commit ec3eb68

Browse files
authored
Migration of the documentation to a major version (#754)
* Update: Migrate all the documentation into a higher version * Update: Add nvmrc file and change node version * Update: enable corepack and yarn * Update: improve the GitHub workflows * Update: Add checkout repository * Update: add setup-node without cache * Update: delete cache field * Update: Remove yarn prepare
1 parent 7c9d5b2 commit ec3eb68

File tree

59 files changed

+16573
-158946
lines changed

Some content is hidden

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

59 files changed

+16573
-158946
lines changed

.firebaserc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"projects": {
33
"default": "astar-docs"
44
}
5-
}
5+
}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Setup Workspace
2+
description: Setup Node.js, Yarn v4 with Corepack, and install dependencies
3+
inputs:
4+
build:
5+
description: 'Whether to run `yarn build` after install'
6+
required: false
7+
default: 'false'
8+
9+
runs:
10+
using: composite
11+
steps:
12+
- name: Setup Node.js (no cache)
13+
uses: actions/setup-node@v3
14+
with:
15+
node-version: 22.x
16+
17+
- name: Enable Corepack
18+
run: corepack enable
19+
shell: bash
20+
21+
- name: Setup Node.js (with Yarn cache)
22+
uses: actions/setup-node@v3
23+
with:
24+
node-version: 22.x
25+
cache: yarn
26+
27+
- name: Install dependencies with Yarn
28+
run: yarn install --frozen-lockfile
29+
shell: bash
30+
31+
- name: Build project (optional)
32+
if: inputs.build == 'true'
33+
run: yarn build
34+
shell: bash

.github/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ changelog:
2222
- bug
2323
- title: 🗣️ Translation
2424
labels:
25-
- translation
25+
- translation

.github/workflows/broken-links.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,13 @@ jobs:
1010
build_and_check:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v3
14-
- uses: actions/setup-node@v3
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Setup workspace and build
17+
uses: ./.github/actions/setup-workspace
1518
with:
16-
node-version: 18.x
17-
cache: yarn
18-
19-
- name: Install and build
20-
run: |
21-
yarn install --frozen-lockfile
22-
yarn build
19+
build: 'true'
2320

2421
- name: Link Checker
2522
id: lychee
@@ -35,4 +32,4 @@ jobs:
3532
with:
3633
title: Link Checker Report
3734
content-filepath: ./lychee/out.md
38-
labels: report, automated issue
35+
labels: report, automated issue

.github/workflows/enforce-labels.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@ jobs:
1010
- uses: yogevbd/[email protected]
1111
with:
1212
REQUIRED_LABELS_ANY: "ci,bug,documentation,duplicate,enhancement,good first issue,help wanted,invalid,question,translation,wontfix,dependencies"
13-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['ci', 'bug','documentation','duplicate','enhancement','good first issue','help wanted','invalid','question','translation','wontfix','dependencies']"
14-
13+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['ci', 'bug','documentation','duplicate','enhancement','good first issue','help wanted','invalid','question','translation','wontfix','dependencies']"

.github/workflows/firebase-hosting-merge.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,18 @@ jobs:
1010
build_and_deploy:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-node@v3
15-
with:
16-
node-version: 18.x
17-
cache: yarn
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
1815

19-
- name: Install and build
20-
run: |
21-
yarn install --frozen-lockfile
22-
yarn build
16+
- name: Setup workspace and build
17+
uses: ./.github/actions/setup-workspace
18+
with:
19+
build: 'true'
2320

2421
- uses: FirebaseExtended/action-hosting-deploy@v0
2522
with:
2623
repoToken: '${{ secrets.GITHUB_TOKEN }}'
2724
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_ASTAR_DOCS }}'
2825
channelId: live
2926
projectId: astar-docs
30-
firebaseToolsVersion: 13.35.1
27+
firebaseToolsVersion: 13.35.1

.github/workflows/firebase-hosting-pull-request.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,17 @@ jobs:
1212
if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v2
16-
- uses: actions/setup-node@v3
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Setup workspace and build
19+
uses: ./.github/actions/setup-workspace
1720
with:
18-
node-version: 18.x
19-
cache: yarn
21+
build: 'true'
2022

21-
- name: Install and build
22-
run: |
23-
yarn install --frozen-lockfile
24-
yarn build
25-
2623
- uses: FirebaseExtended/action-hosting-deploy@v0
2724
with:
2825
repoToken: '${{ secrets.GITHUB_TOKEN }}'
2926
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_ASTAR_DOCS }}'
3027
projectId: astar-docs
31-
firebaseToolsVersion: 13.35.1
28+
firebaseToolsVersion: 13.35.1

.github/workflows/md-link-checker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
- uses: gaurav-nelson/github-action-markdown-link-check@0a51127e9955b855a9bbfa1ff5577f1d1338c9a5 # 1.0.14
1717
with:
1818
use-quiet-mode: 'yes'
19-
config-file: '.github/workflows/mlc_config.json'
19+
config-file: '.github/workflows/mlc_config.json'

.github/workflows/monthly-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ jobs:
6565
with:
6666
tag_name: ${{ steps.create_tag.outputs.new_tag }}
6767
release_name: Release ${{ steps.create_tag.outputs.new_tag }}
68-
body: ${{ steps.create_release_note.outputs.changelog }}
68+
body: ${{ steps.create_release_note.outputs.changelog }}

.github/workflows/s3-merge.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,19 @@ jobs:
77
build_and_deploy:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v2
11-
- uses: actions/setup-node@v3
10+
- name: Checkout repository
11+
uses: actions/checkout@v4
12+
13+
- name: Setup workspace and build
14+
uses: ./.github/actions/setup-workspace
1215
with:
13-
node-version: 18.x
14-
cache: yarn
16+
build: 'true'
1517

16-
- name: Install and build
17-
run: |
18-
yarn install --frozen-lockfile
19-
yarn build
2018
- uses: aws-actions/configure-aws-credentials@v1
2119
with:
2220
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
2321
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
2422
aws-region: ${{ secrets.AWS_REGION }}
23+
2524
- name: Deploy app build to S3 bucket
26-
run: aws s3 sync ./build s3://astar-docs --delete
25+
run: aws s3 sync ./build s3://astar-docs --delete

0 commit comments

Comments
 (0)