Skip to content

Add blog CI checks pipeline#3

Merged
wuchong merged 1 commit into
apache:mainfrom
wuchong:blog-checks
Apr 18, 2026
Merged

Add blog CI checks pipeline#3
wuchong merged 1 commit into
apache:mainfrom
wuchong:blog-checks

Conversation

@wuchong
Copy link
Copy Markdown
Member

@wuchong wuchong commented Apr 18, 2026

No description provided.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a GitHub Actions workflow intended to run CI checks for the blog on pushes and PRs targeting main.

Changes:

  • Introduces a new Check Blog workflow triggered on push and pull_request to main.
  • Checks out the repo, sets up Node.js, installs dependencies, and runs a Docusaurus build.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# limitations under the License.
################################################################################

# This workflow is meant for checking broken links in the blog.
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The header comment says this workflow checks broken links, but the job only runs docusaurus build and the site config currently sets onBrokenLinks: 'warn', so broken links won't fail CI. Either update the description to match (build-only) or adjust the build/link-checking so broken links cause a failure (e.g., CI-specific onBrokenLinks: 'throw').

Suggested change
# This workflow is meant for checking broken links in the blog.
# This workflow is meant for validating that the blog builds successfully.

Copilot uses AI. Check for mistakes.
with:
node-version: 24
- name: Install dependencies
run: npm install
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI uses npm install but the repo doesn't include a lockfile, which makes dependency resolution non-deterministic and can cause flaky builds over time. Consider committing a lockfile (package-lock.json) and switching CI to npm ci for reproducible installs (and enabling setup-node caching once a lockfile exists).

Suggested change
run: npm install
run: |
if [ ! -f package-lock.json ]; then
echo "package-lock.json is required for reproducible CI installs. Commit the lockfile and rerun."
exit 1
fi
npm ci

Copilot uses AI. Check for mistakes.
branches: [main]

jobs:
test-deploy:
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Job id test-deploy is misleading in a workflow named "Check Blog" (it neither tests nor deploys). Renaming it to something like build/check makes the Actions UI and logs easier to interpret.

Suggested change
test-deploy:
check:

Copilot uses AI. Check for mistakes.
@wuchong wuchong merged commit de9bb0a into apache:main Apr 18, 2026
5 checks passed
@wuchong wuchong deleted the blog-checks branch April 18, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants