Skip to content
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

CI: Deploy documentation HTML ZIP archive and PDF file for dev versions #3794

Merged
merged 5 commits into from
Feb 18, 2025

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 8, 2025

For dev versions, deploy the pygmt-docs.zip and pygmt-docs.pdf files into the dev folder in the gh-pages branch.

Addressing #3731 (comment).

@seisman seisman added the maintenance Boring but important stuff for the core devs label Feb 8, 2025
Comment on lines 159 to 164
- name: Upload the HTML ZIP archive and PDF as release assets
run: gh release upload ${{ github.ref_name }} doc/_build/pygmt-docs.zip doc/_build/pygmt-docs.pdf
if: github.event_name == 'release' && matrix.os == 'ubuntu-latest'
env:
GH_TOKEN: ${{ github.token }}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plan is to keep the first two steps in this PR and open a separate PR for the 3rd step (uploading as release assets) since this step needs more testing than the other two steps.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted in c4a3fa1.

@seisman seisman changed the title POC: CI: Deploy documentation HTML ZIP archive and PDF file for dev and releases CI: Deploy documentation HTML ZIP archive and PDF file for dev versions Feb 9, 2025
@seisman seisman added this to the 0.15.0 milestone Feb 15, 2025
@seisman seisman added the needs review This PR has higher priority and needs review. label Feb 15, 2025
@seisman seisman marked this pull request as ready for review February 15, 2025 09:49
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Feb 17, 2025
@seisman seisman requested a review from a team February 17, 2025 06:52
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 18, 2025
@seisman seisman merged commit faa635d into main Feb 18, 2025
10 checks passed
@seisman seisman deleted the ci/docs-html-pdf branch February 18, 2025 02:16
@seisman
Copy link
Member Author

seisman commented Feb 18, 2025

With this PR merged, now the HTML ZIP and PDF file for the dev version can be accessed using the following links:

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant