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

Add a workflow to upload baseline images as a release asset #1317

Merged
merged 5 commits into from
Jun 9, 2021

Conversation

seisman
Copy link
Member

@seisman seisman commented Jun 3, 2021

Description of proposed changes

In this PR, a workflow is added to upload all baseline PNG images as a release
asset when a release is published.

Fixes #1201.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added the maintenance Boring but important stuff for the core devs label Jun 3, 2021
@seisman
Copy link
Member Author

seisman commented Jun 3, 2021

Because the workflow only runs when a new release is made, I committed it directly to my own fork (https://github.com/seisman/pygmt/blob/master/.github/workflows/release-baseline-images.yml), and made a release at https://github.com/seisman/pygmt/releases/tag/v0.3.2.

The workflow runs well (https://github.com/seisman/pygmt/actions/workflows/release-baseline-images.yml) and the baseline images are correctly uploaded at https://github.com/seisman/pygmt/releases/tag/v0.3.2.

@weiji14
Copy link
Member

weiji14 commented Jun 4, 2021

Cool, great work @seisman! This new workflow needs to be documented in maintenance.md. Also, do we want these baseline images stored on Zenodo too? If so, we'll need to update the PyGMT 'how to release' documentation too.

@seisman
Copy link
Member Author

seisman commented Jun 4, 2021

This new workflow needs to be documented in maintenance.md.

Done in dc30267.

Also, do we want these baseline images stored on Zenodo too? If so, we'll need to update the PyGMT 'how to release' documentation too.

Does it mean we (mainly you) have to manually upload the zip archive to Zenodo?

@seisman seisman added this to the 0.4.0 milestone Jun 4, 2021
@seisman seisman marked this pull request as ready for review June 5, 2021 03:17
@seisman seisman requested a review from a team June 7, 2021 01:35
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Also, do we want these baseline images stored on Zenodo too? If so, we'll need to update the PyGMT 'how to release' documentation too.

Does it mean we (mainly you) have to manually upload the zip archive to Zenodo?

Yes, I'll need to upload it to Zenodo. Maybe also change:

  1. the note at https://github.com/GenericMappingTools/pygmt/blob/master/doc/maintenance.md#archiving-on-zenodo to say "Grab both the source code and baseline images zip files from the GitHub release page and upload them to Zenodo using the previously reserved DOI".
  2. The last 'Release' bullet point at https://github.com/GenericMappingTools/pygmt/blob/master/.github/ISSUE_TEMPLATE/release_checklist.md to say "Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to ..."

doc/maintenance.md Outdated Show resolved Hide resolved
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Jun 8, 2021
@seisman seisman merged commit 69181d1 into master Jun 9, 2021
@seisman seisman deleted the release-assets branch June 9, 2021 01:33
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…appingTools#1317)

* Add a workflow to upload baseline images as a release asset
* Add the new workflow to maintenance.md

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Meghan Jones <[email protected]>
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.

Add baseline images as a release asset for each release
3 participants