-
Notifications
You must be signed in to change notification settings - Fork 98
Migration of the documentation to a major version #754
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b06e09b
Update: Migrate all the documentation into a higher version
Juminstock 1837913
Update: Add nvmrc file and change node version
Juminstock 0b2b3c8
Update: enable corepack and yarn
Juminstock b9cbe4d
Update: improve the GitHub workflows
Juminstock 05ece7a
Update: Add checkout repository
Juminstock f8953ef
Update: add setup-node without cache
Juminstock 31379c4
Update: delete cache field
Juminstock f6222b5
Update: Remove yarn prepare
Juminstock File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,4 @@ | |
| "projects": { | ||
| "default": "astar-docs" | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Setup Workspace | ||
| description: Setup Node.js, Yarn v4 with Corepack, and install dependencies | ||
| inputs: | ||
| build: | ||
| description: 'Whether to run `yarn build` after install' | ||
| required: false | ||
| default: 'false' | ||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 22.x | ||
| cache: yarn | ||
|
|
||
| - name: Enable Corepack | ||
| run: corepack enable | ||
| shell: bash | ||
|
|
||
| - name: Prepare Yarn | ||
| run: corepack prepare yarn@4.9.2 --activate | ||
| shell: bash | ||
|
|
||
| - name: Install dependencies with Yarn | ||
| run: yarn install --frozen-lockfile | ||
| shell: bash | ||
|
|
||
| - name: Build project (optional) | ||
| if: inputs.build == 'true' | ||
| run: yarn build | ||
| shell: bash | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,4 +22,4 @@ changelog: | |
| - bug | ||
| - title: 🗣️ Translation | ||
| labels: | ||
| - translation | ||
| - translation | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,73 @@ | ||
| # Dependencies | ||
| /node_modules | ||
| # ------------------------ | ||
| # ⚙️ Node / Yarn / Docusaurus | ||
| # ------------------------ | ||
|
|
||
| # Production | ||
| /build | ||
| # Node modules (legacy, if nodeLinker: node-modules) | ||
| node_modules/ | ||
|
|
||
| # Generated files | ||
| .docusaurus | ||
| .cache-loader | ||
| # Docusaurus build output | ||
| build/ | ||
| !docs/build/ | ||
| .docusaurus/ | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
| # Yarn v2+ PnP (Zero-install support) | ||
| .yarn/* | ||
| !.yarn/cache | ||
| !.yarn/releases | ||
| !.yarn/plugins | ||
| !.yarn/sdks | ||
| !.yarn/versions | ||
| .pnp.* | ||
| .yarnrc.yml | ||
|
|
||
| # ------------------------ | ||
| # 📝 Config / Env files | ||
| # ------------------------ | ||
|
|
||
| .env | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| # ------------------------ | ||
| # 🛠️ Editor / System | ||
| # ------------------------ | ||
|
|
||
| # VS Code | ||
| .vscode/ | ||
| # JetBrains | ||
| .idea/ | ||
| # Vim / Swap | ||
| *.swp | ||
| # macOS | ||
| .DS_Store | ||
| # Windows | ||
| Thumbs.db | ||
|
|
||
| # ------------------------ | ||
| # 🧪 Tests / Debug | ||
| # ------------------------ | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # yarn v2 | ||
| .yarn/* | ||
| .yarnrc.yml | ||
| !.yarn/cache # Uncomment for zero-install | ||
| !.yarn/releases | ||
| !.yarn/plugins | ||
| !.yarn/sdks | ||
| !.yarn/versions | ||
| # .pnp.* # Comment for zero-install | ||
| package.json | ||
| # ------------------------ | ||
| # 🧱 TypeScript | ||
| # ------------------------ | ||
|
|
||
| *.tsbuildinfo | ||
|
|
||
| # ------------------------ | ||
| # 📊 Output / Coverage | ||
| # ------------------------ | ||
|
|
||
| coverage/ | ||
|
|
||
| # ------------------------ | ||
| # 🔥 Firebase (optional) | ||
| # ------------------------ | ||
|
|
||
| .firebase/ | ||
| .firebaserc |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v18.0 | ||
| 22.17.0 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems like these lines need to be running before setup-node. If they fail to run due to node not being installed, maybe do setup-node twice with the first one not doing the cache. Still, I feel like there's a better way to do this overall
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actions/setup-node#182 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JGJP Thank you for your comment. In that case, based on the context you provided, I believe running
setup-nodetwice will be the most effective and clean solution for now. The implementation would look like this:name: Setup Workspace description: Setup Node.js, Yarn v4 with Corepack, and install dependencies inputs: build: description: 'Whether to run `yarn build` after install' required: false default: 'false' runs: using: composite steps: # Step 1: Setup Node.js without Yarn cache (just to activate Corepack/Yarn) - name: Setup Node.js (no cache) uses: actions/setup-node@v3 with: node-version: 22.x cache: false - name: Enable Corepack run: corepack enable shell: bash - name: Prepare Yarn 4.9.2 run: corepack prepare yarn@4.9.2 --activate shell: bash # Step 2: Setup Node.js again — now with Yarn cache enabled - name: Setup Node.js (with Yarn cache) uses: actions/setup-node@v3 with: node-version: 22.x cache: yarn - name: Install dependencies with Yarn run: yarn install --immutable shell: bash - name: Build project (optional) if: inputs.build == 'true' run: yarn build shell: bash@JGJP what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, let's try it and see if the build runs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like it's building, there's some error about Buffer but seems unrelated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it worked!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might be able to get away with removing the yarn preparation step