jekyll-gh-pages.yml #8250
jekyll-gh-pages.yml #8250
Conversation
Signed-off-by: Katiso Seipati <[email protected]>
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
|
@Slain03 is attempting to deploy a commit to the thirdweb Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughAdds a new GitHub Actions workflow to build a Jekyll site and deploy it to GitHub Pages. It defines triggers, permissions, concurrency, a build job (checkout, configure Pages, build, upload artifact), and a deploy job (depends on build, deploys to Pages). Includes a mis-indented Node setup block. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant GH as GitHub Actions
participant Build as Job: build
participant Deploy as Job: deploy
participant Pages as GitHub Pages
Dev->>GH: push to main / manual dispatch
GH->>Build: Start build job
Build->>Build: Checkout repo
Build->>Build: Configure Pages
Build->>Build: Jekyll build
Build-->>GH: Upload artifact
GH->>Deploy: Start deploy job (needs build)
note right of Deploy: Mis-indented Node setup block present
Deploy->>Pages: Deploy artifact to Pages
Pages-->>Dev: Site published
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.github/workflows/jekyll-gh-pages.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.8)
.github/workflows/jekyll-gh-pages.yml
52-52: could not parse as YAML: mapping values are not allowed in this context
(syntax-check)
🪛 YAMLlint (1.37.1)
.github/workflows/jekyll-gh-pages.yml
[error] 52-52: syntax error: mapping values are not allowed here
(syntax)
| uses: actions/deploy-pages@v4 | ||
| - name: Setup Node.js environment | ||
| uses: actions/[email protected] | ||
| with: | ||
| # Set always-auth in npmrc. | ||
| always-auth: # optional, default is false | ||
| # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0. | ||
| node-version: # optional | ||
| # File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions. | ||
| node-version-file: # optional | ||
| # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default. | ||
| architecture: # optional | ||
| # Set this option if you want the action to check for the latest available version that satisfies the version spec. | ||
| check-latest: # optional | ||
| # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN. | ||
| registry-url: # optional | ||
| # Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | ||
| scope: # optional | ||
| # Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ||
| token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }} | ||
| # Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm. | ||
| cache: # optional | ||
| # Set to false to disable automatic caching based on the package manager field in package.json. By default, caching is enabled if the package manager field is present. | ||
| package-manager-cache: # optional, default is true | ||
| # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies. | ||
| cache-dependency-path: # optional | ||
| # Used to specify an alternative mirror to downlooad Node.js binaries from | ||
| mirror: # optional | ||
| # The token used as Authorization header when fetching from the mirror | ||
| mirror-token: # optional |
There was a problem hiding this comment.
Fix YAML syntax before merge.
The Setup Node.js environment block is at the wrong indentation level, so the workflow file no longer parses (mapping values are not allowed in this context). GitHub Actions will ignore the entire workflow until this is fixed. Either remove the stray template block or add it as its own properly indented step, e.g.:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
- - name: Setup Node.js environment
- uses: actions/[email protected]
- with:
- always-auth:
- node-version:
- node-version-file:
- architecture:
- check-latest:
- registry-url:
- scope:
- token:
- cache:
- package-manager-cache:
- cache-dependency-path:
- mirror:
- mirror-token:
+ - name: Setup Node.js environment
+ uses: actions/setup-node@v5
+ with:
+ node-version: 20(Adjust or drop the step as needed.)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| uses: actions/deploy-pages@v4 | |
| - name: Setup Node.js environment | |
| uses: actions/[email protected] | |
| with: | |
| # Set always-auth in npmrc. | |
| always-auth: # optional, default is false | |
| # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0. | |
| node-version: # optional | |
| # File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions. | |
| node-version-file: # optional | |
| # Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default. | |
| architecture: # optional | |
| # Set this option if you want the action to check for the latest available version that satisfies the version spec. | |
| check-latest: # optional | |
| # Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN. | |
| registry-url: # optional | |
| # Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | |
| scope: # optional | |
| # Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | |
| token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }} | |
| # Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm. | |
| cache: # optional | |
| # Set to false to disable automatic caching based on the package manager field in package.json. By default, caching is enabled if the package manager field is present. | |
| package-manager-cache: # optional, default is true | |
| # Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies. | |
| cache-dependency-path: # optional | |
| # Used to specify an alternative mirror to downlooad Node.js binaries from | |
| mirror: # optional | |
| # The token used as Authorization header when fetching from the mirror | |
| mirror-token: # optional | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| - name: Setup Node.js environment | |
| uses: actions/setup-node@v5 | |
| with: | |
| node-version: 20 |
🧰 Tools
🪛 actionlint (1.7.8)
52-52: could not parse as YAML: mapping values are not allowed in this context
(syntax-check)
🪛 YAMLlint (1.37.1)
[error] 52-52: syntax error: mapping values are not allowed here
(syntax)
🤖 Prompt for AI Agents
.github/workflows/jekyll-gh-pages.yml around lines 51-80: the "Setup Node.js
environment" block is incorrectly indented and currently breaks YAML parsing;
either remove this stray template block or move it into the job's steps array
with correct indentation and keys (e.g., as a step under jobs.<job_id>.steps
with a top-level - name: "Setup Node.js environment" and the uses:
actions/[email protected] line aligned under that step), ensure only valid step
keys (name, uses, with) are present, remove the inline commented parameter list
or convert it to proper with: entries if you intend to configure options, and
re-validate the workflow YAML to confirm parsing succeeds before merging.
2 participants
PR-Codex overview
This PR introduces a GitHub Actions workflow for building and deploying a Jekyll site to GitHub Pages, with preinstalled dependencies and configured steps for both building and deploying the site.
Detailed summary
Deploy Jekyll with GitHub Pages dependencies preinstalled.pushto themainbranch and manual dispatch.GITHUB_TOKENfor deployment.buildjob with steps to checkout, setup pages, build with Jekyll, and upload artifacts.deployjob that requires thebuildjob and deploys to GitHub Pages.Summary by CodeRabbit
New Features
Chores