Skip to content

CI: Upload the documentation PDF file as artifact for previewing #3837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

seisman
Copy link
Member

@seisman seisman commented Mar 6, 2025

Upload the PDF file as artifact so that anyone can download the file and we don't have to build it ourselves just for previewing the changes.

@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Mar 6, 2025
@seisman seisman added this to the 0.15.0 milestone Mar 6, 2025
@seisman seisman requested a review from Copilot March 6, 2025 06:26
Copy link
Contributor

@Copilot 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.

PR Overview

This pull request adds a new CI step that uploads the generated documentation PDF as an artifact, allowing for easy previewing without rebuilding the docs manually.

  • Added a step to upload the PDF artifact on push events with Ubuntu runners
  • Retained the release asset upload step for both the HTML ZIP and PDF files

Reviewed Changes

File Description
.github/workflows/ci_docs.yml Added new step for uploading the PDF as an artifact

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

.github/workflows/ci_docs.yml:156

  • [nitpick] Consider using consistent quotation marks for the event name condition to match the rest of the file, for example using single quotes for 'push'.
if: github.event_name == "push" && matrix.os == 'ubuntu-latest'

@seisman seisman removed the needs review This PR has higher priority and needs review. label Mar 6, 2025
@seisman seisman merged commit eb0ebe7 into main Mar 6, 2025
10 checks passed
@seisman seisman deleted the ci/pdf-artifact branch March 6, 2025 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant