feat(workflows): add reusable Docusaurus workflow (DX-2760)#1398
Open
feat(workflows): add reusable Docusaurus workflow (DX-2760)#1398
Conversation
Convert docs-test and docs-deploy composite actions to reusable workflows for consistency with other .github workflows.
Contributor
|
👋 sebawo, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…cusaurus Single reusable workflow with two jobs: docs-test (build + test) and docs-deploy (build + deploy to GitHub Pages). Deploy runs after test succeeds. Remove reusable-docs-test.yml and reusable-docs-deploy.yml.
sebawo
changed the title
Pin smartcontractkit/.github/actions/setup-nodejs to commit hash (43fe7fd) to resolve CodeQL unpinned-action warning.
chainchad
requested changes
Jan 30, 2026
Co-authored-by: chainchad <96362174+chainchad@users.noreply.github.com>
chainchad
reviewed
Jan 30, 2026
chainchad
reviewed
Jan 30, 2026
chainchad
previously approved these changes
Jan 30, 2026
erikburt
reviewed
Jan 30, 2026
Remove actions/docs-test and actions/docs-deploy; Docusaurus build/test and deploy is now only via reusable-docusaurus.yml workflow. Remove docs-actions-minor changeset and update pnpm-lock.yaml.
Build once, then run test (if set), upload pages artifact, and deploy. Removes duplicate build and second job (docs-deploy).
Co-authored-by: chainchad <96362174+chainchad@users.noreply.github.com>
- reusable-docusaurus: add job-level permissions (contents, pages, id-token) and header comment documenting required permissions; no workflow-level perms - pull-request-main: add workflow-permissions-check job to fail when reusable workflows have non-empty workflow-level permissions
chainchad
force-pushed
the
convert-docs-actions-to-reusable-workflows
branch
from
e4a32e6 to
4575245
Compare
| - uses: actions/checkout@v6 | ||
|
|
||
| - name: Setup nodejs | ||
| uses: smartcontractkit/.github/actions/setup-nodejs@setup-nodejs/v1 |
Check warning
Code scanning / CodeQL
Unpinned tag for a non-immutable Action in workflow Medium
Collaborator
Author
There was a problem hiding this comment.
@chainchad we need to write the custom config to skip those findings for internal actions.
sebawo
changed the title
erikburt
reviewed
Feb 2, 2026
…rectory with pnpm -C Co-authored-by: Cursor <cursoragent@cursor.com>
…g validates docs) Co-authored-by: Cursor <cursoragent@cursor.com>
…ain) Co-authored-by: Cursor <cursoragent@cursor.com>
Resolve modify/delete conflicts: keep removal of actions/docs-deploy and actions/docs-test (replaced by reusable workflow). Co-authored-by: Cursor <cursoragent@cursor.com>
erikburt
reviewed
Feb 12, 2026
Comment on lines
+68
to
+72
| deployment-branch: | ||
| description: "branch to deploy to (e.g., gh-pages)" | ||
| required: false | ||
| type: string | ||
| default: "gh-pages" |
Comment on lines
+58
to
+67
| github-event-name: | ||
| description: "the GitHub event name that triggered the calling workflow (e.g., push, pull_request, merge_group)" | ||
| required: false | ||
| type: string | ||
| default: "workflow_call" | ||
| github-ref: | ||
| description: "the GitHub ref that triggered the calling workflow (e.g., refs/heads/main)" | ||
| required: false | ||
| type: string | ||
| default: "" |
Contributor
There was a problem hiding this comment.
I believe these are already available from the original calling context. So they aren't needed as inputs.
For example: https://github.com/smartcontractkit/releng-test/actions/runs/21961260549/job/63439049182?pr=159
# https://github.com/smartcontractkit/releng-test/actions/runs/21961366180/job/63439420326#step:3:44
GITHUB_REF=refs/heads/main
# https://github.com/smartcontractkit/releng-test/actions/runs/21961366180/job/63439420326#step:3:91
GITHUB_REF_NAME=main
# https://github.com/smartcontractkit/releng-test/actions/runs/21961366180/job/63439420326#step:3:61
GITHUB_EVENT_NAME=push
These are accessible as env vars or like:
${{ github.event_name }}${{ github.ref_name }}- etc...
| uses: actions/upload-pages-artifact@v4.0.0 | ||
| with: | ||
| path: >- | ||
| ${{ inputs.package-json-directory }}/${{ inputs.build-output-directory }} |
Contributor
There was a problem hiding this comment.
I don't think this should include package-json-directory.
The path can be relative to the repository root as the other inputs, or can be an absolute path if they are outputting to /tmp for example.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add a single reusable workflow for Docusaurus documentation: build, test (optional), and deploy to GitHub Pages. Remove the former composite actions in favor of the workflow only.
Changes
Added
docusaurus): checkout, setup Node.js (pinned ref), build docs, (optional) run tests, upload pages artifact, deploy to GitHub Pages. Build runs once; no duplicate jobs.Callers use one
workflow_callto run build, test, and deploy in a single job.Security
smartcontractkit/.github/actions/setup-nodejsto commit hash (setup-nodejs@0.2.3) to satisfy CodeQL unpinned-action requirement.Removed
Other
actions/docs-testandactions/docs-deployfrom lockfile.