ci: attach examples and website assets to GitHub releases #996
Conversation
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
tbouffard
added
the
chore
WalkthroughAdds two reusable GitHub Actions workflows for building examples and generating the website; refactors build and generate-website workflows to call those reusables; updates the release workflow to derive VERSION, run the reusable builds, collect artifacts, and attach versioned examples/website archives to the GitHub release. (37 words) Changes
Sequence Diagram(s)sequenceDiagram
actor TagPush as Tag Push
participant GHA as GitHub Actions
participant ComputeEnv as compute_environment_variables
participant ReusableExamples as build_examples (reusable)
participant ReusableWebsite as generate_website (reusable)
participant CreateRelease as create_release
participant GHRelease as GitHub Release
TagPush->>GHA: trigger release pipeline
GHA->>ComputeEnv: extract VERSION from tag
ComputeEnv-->>GHA: outputs VERSION
GHA->>ReusableExamples: invoke (artifact-name=examples-VERSION, runner)
ReusableExamples-->>GHA: upload examples artifact
GHA->>ReusableWebsite: invoke (artifact-name=website-VERSION or gh-pages)
ReusableWebsite-->>GHA: upload website artifact
GHA->>CreateRelease: run create_release (needs: compute + build jobs)
CreateRelease->>GHA: download artifacts (examples, website)
CreateRelease->>GHRelease: attach versioned archives and publish release
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…t not for gh-pages (docusaurus requirements)
tbouffard
changed the title
Windows GitHub Actions runners default to PowerShell, which doesn't properly execute bash scripts. Adding explicit shell: bash ensures the build script runs correctly on all platforms.
tbouffard
commented
Jan 23, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/create-github-release.yml (1)
41-63: Addissues: readpermission for milestone GraphQL query.Querying repository milestones via the GraphQL API requires the
issues: readpermission. Without it, thegh api graphqlcall will fail and leaveMILESTONE_NUMBERunset.Proposed fix
create_release: runs-on: ubuntu-24.04 needs: [compute_environment_variables, build_examples, generate_website] permissions: contents: write # create the GH release + issues: read
♻️ Duplicate comments (1)
.github/workflows/create-github-release.yml (1)
21-35: Addactions: writeto reusable-workflow callers for artifact uploads.The caller permissions cap the reusable workflows. If
_reusable_build_examples.yml/_reusable_generate_website.ymlupload artifacts, they needactions: write, which is currently missing.✅ Proposed fix
build_examples: needs: compute_environment_variables permissions: contents: read + actions: write uses: ./.github/workflows/_reusable_build_examples.yml with: artifact-name: 'maxgraph_${{ needs.compute_environment_variables.outputs.version }}_examples.zip' generate_website: needs: compute_environment_variables permissions: contents: read + actions: write uses: ./.github/workflows/_reusable_generate_website.yml with: artifact-name: 'maxgraph_${{ needs.compute_environment_variables.outputs.version }}_website.zip'Please verify the reusable workflows actually upload artifacts:
#!/bin/bash rg -n "actions/(upload-artifact|upload-pages-artifact)" .github/workflows/_reusable_build_examples.yml .github/workflows/_reusable_generate_website.yml
tbouffard
commented
Jan 26, 2026
tbouffard
commented
Feb 2, 2026
tbouffard
commented
Feb 2, 2026
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This eliminates manual steps for attaching release assets.
Notes
Closes #859
Covers #889
Remaining Tasks
Summary by CodeRabbit
New Features
Release
Documentation