Skip to content

ci: adopt shared Docusaurus releases and update workflows - #117

Merged
neilime merged 1 commit into
mainfrom
feat/shared-release-workflow
Nov 8, 2026
Merged

ci: adopt shared Docusaurus releases and update workflows#117
neilime merged 1 commit into
mainfrom
feat/shared-release-workflow

Conversation

@neilime

@neilime neilime commented Nov 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Release the public Docusaurus theme through shared manual/weekly preparation, validation, and publication. Build the documentation as a separate installed consumer before publishing the tested tarball.

Changes

  • Run release labeling only on pull request events. Keep preparation, validation and publication as separate jobs; skip validation/publication when no release is planned.
  • Use GitHub self-repository references ($/) for local actions and reusable workflows.
  • Pin every external GitHub Action and reusable workflow to its latest stable release commit, including ci-github-common 2.0.2 and ci-github-publish 3.0.0. Use repository-configured PR-title validation with only contents: read.
  • Prepare packages/theme while keeping the documentation workspace private. Move npm publication out of main CI and retain main-branch Pages deployment.
  • Use package.test-project: packages/docs and its build command for isolated consumer validation. Reuse built theme files when packing.
  • Align the package manifest and lockfile with the published version, retain PR release labeling, and document GitHub App setup, npm trusted publishing, optional summaries, force, and recovery.

Validation

Release trigger, manual force, no-change gate, validation dependency, configuration and artifact-handoff checks pass against the released shared workflows.

Actionlint, YAML formatting, git diff --check, and released action/workflow input, output, secret, and permission contracts pass locally. The CI checks run source tests and package validation against the pinned shared implementation.

Before merging

Uses released ci-github-nodejs 2.1.0, pinned to 02a04ad25ceaacdf3b7200e45fb7fec07fadf4fa for preparation, validation and publication.

Configure CI_BOT_APP_CLIENT_ID and CI_BOT_APP_PRIVATE_KEY with permission to push signed version commits/tags and dispatch the prepared workflow. Configure npm trusted publishing for this repository and release.yml, with no npm environment restriction. Any Pages environment must allow prepared release tags. CHANGELOG_SUMMARY is optional.

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Fail ❌
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Fail ❌
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

CHECKOV 
dockerfile scan results:

Passed checks: 15, Failed checks: 0, Skipped checks: 0

github_actions scan results:

Passed checks: 82, Failed checks: 1, Skipped checks: 1

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(Release)
	File: /.github/workflows/release.yml:6-11

		6  |       force:
		7  |         description: Release the package even without changes
		8  |         type: boolean
		9  |         default: false
		10 |   schedule:
		11 |     - cron: "25 8 * * 1"
NATURAL_LANGUAGE 

/github/workspace/docs/development/releasing.md
  51:4   ✓ error  Incorrect term: “Website”, use “Site” instead  terminology
  53:33  ✓ error  Incorrect term: “website”, use “site” instead  terminology

✖ 2 problems (2 errors, 0 warnings, 0 infos)
✓ 2 fixable problems.
Try to run: $ textlint --fix [file]

@github-actions

github-actions Bot commented Nov 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Code Coverage Report

Coverage Results

Test Results

Status Count
✅ Passed 24
❌ Failed 0
⏭️ Skipped 0
Total 24
Suite Passed Failed Skipped
src/__tests__/index.test.ts 6 0 0
src/__tests__/validateThemeConfig.test.ts 5 0 0
src/theme/__tests__/HoverkraftBrandHighlight.test.tsx 3 0 0
src/theme/__tests__/HoverkraftButton.test.tsx 2 0 0
src/theme/__tests__/HoverkraftFeatureList.test.tsx 1 0 0
src/theme/__tests__/HoverkraftHero.test.tsx 2 0 0
src/theme/__tests__/HoverkraftProjectCard.test.tsx 1 0 0
tests/config.test.ts 4 0 0

✅ Pass Rate: 100.0%

packages/docs/coverage/lcov.info

Coverage

Metric Covered Total Percentage
Lines 2 2 100.00%

Overall: 100.00% 🟢
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

packages/theme/coverage/lcov.info

Coverage

Metric Covered Total Percentage
Lines 60 72 83.33%
Branches 86 122 70.49%
Functions 19 22 86.36%

Overall: 83.33% 🟢
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩⬜⬜⬜

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions github-actions Bot added the type: feature Introduces a new feature label Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@neilime neilime changed the title feat(ci): adopt shared package release workflow ci(release): adopt shared Docusaurus theme releases Nov 6, 2026
@neilime
neilime force-pushed the feat/shared-release-workflow branch from 805acc8 to b8e6cae Compare November 6, 2026 19:57
@github-actions github-actions Bot added the type: maintenance Performs maintenance work label Nov 6, 2026
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@neilime
neilime force-pushed the feat/shared-release-workflow branch 2 times, most recently from 9f814fd to 7539dba Compare November 8, 2026 17:55
@github-actions

github-actions Bot commented Nov 8, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@neilime
neilime force-pushed the feat/shared-release-workflow branch from 7539dba to 02336c1 Compare November 8, 2026 18:42
@neilime neilime changed the title ci(release): adopt shared Docusaurus theme releases ci: adopt shared Docusaurus releases and update workflows Nov 8, 2026
@github-actions

github-actions Bot commented Nov 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Super-linter summary

Language Validation result
BIOME_FORMAT Pass ✅
BIOME_LINT Pass ✅
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_COMMITLINT Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
JSCPD Pass ✅
MARKDOWN Pass ✅
MARKDOWN_PRETTIER Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅
YAML_PRETTIER Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter
Super-linter revision: 2da136927bd4a73596db63044b504547c62cb854
Super-linter version: 9.0.0

@neilime
neilime force-pushed the feat/shared-release-workflow branch from 02336c1 to 1537661 Compare November 8, 2026 18:50
@neilime
ci: adopt shared Docusaurus releases and update workflows
6b32cd0 
Adopt shared release preparation and validated theme publication. Build
the documentation as an installed package consumer, align package versions,
and retain main-branch Pages deployment.

Pin GitHub Actions and reusable workflows to current stable releases.
Adapt workflow permissions and repository-configured PR title validation.
@neilime
neilime force-pushed the feat/shared-release-workflow branch from 1537661 to 6b32cd0 Compare November 8, 2026 19:12
@neilime
neilime marked this pull request as ready for review November 8, 2026 19:42
@neilime
neilime merged commit 6e467f4 into main Nov 8, 2026
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

type: feature Introduces a new feature type: maintenance Performs maintenance work

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@neilime