Skip to content

Include documentation PDFs in GitHub releases#60

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/update-release-includes-guide-pdf
Jan 8, 2026
Merged

Include documentation PDFs in GitHub releases#60
Malcolmnixon merged 2 commits intomainfrom
copilot/update-release-includes-guide-pdf

Conversation

Copy link
Contributor

Copilot AI commented Jan 8, 2026

Releases were missing the guide.pdf file built by the build-docs job.

Changes

Modified .github/workflows/release.yaml:

  • Job dependency: Added build-docs to release job's needs array so it waits for documentation build to complete
  • Artifact download: Added step to download documentation artifact to artifacts folder alongside existing build artifacts
  • Release inclusion: Existing artifacts/**/* pattern now captures documentation PDFs automatically

The workflow now includes documentation PDFs in release artifacts without requiring any changes to the release creation step.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Releases Include Guide PDF</issue_title>
<issue_description>### Problem Statement

Releases don't include the guide.pdf file built by the build-docs job.

Proposed Solution

Update release.yaml so it:

  • has the 'release' job depends on the 'build-docs' job
  • downloads the 'documentation' artifacts from it to the 'artifacts' folder (which will contain all documentation PDFs including guide.pdf)
  • continue to make the release as usual with the 'artifacts/**/*' pattern so the release contains the documentation PDFs.

Alternatives Considered

No response

Usage Examples

Benefits

Improved instructions for users

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update release.yaml to include guide PDF in releases Include documentation PDFs in GitHub releases Jan 8, 2026
Copilot AI requested a review from Malcolmnixon January 8, 2026 04:19
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 8, 2026 04:19
@Malcolmnixon Malcolmnixon merged commit a7005e2 into main Jan 8, 2026
9 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-release-includes-guide-pdf branch January 8, 2026 04:21
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.

[Feature]: Releases Include Guide PDF

2 participants