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.

Sign up for GitHub

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

Jump to bottom

Misc release items #1837

Merged
merged 8 commits into from Apr 28, 2021
Merged

Misc release items #1837

merged 8 commits into from Apr 28, 2021

Conversation

dopplershift
Copy link
Member

Description Of Changes

Started out to fix the handling of docs on release, but has a few other things:

  • Only deploy docs from Python 3.9 build
  • Make sure we deploy docs explicitly when a release is made (to take main and put in a versioned directory)
  • Tweak draft release announcement to set that we want to automatically create a discussion item for the release
  • Sets our release action to use the PyPI environment, which is the only environment now that has access to our PyPI upload token
  • Tweak linting workflow to make sure a failure by flake8 fails the workflow
  • Fix a problem with formula rendering in a couple docstrings
  • Update the infrastructure guide for the workflow added to gh-pages in CI: Add workflow for managing version listing #1836

Checklist

@dopplershift
CI: Only deploy docs on Python 3.9 build
58dc152 
This keeps us from deploying twice for each merge like we currently are.
@dopplershift
CI: Build and deploy docs on release
def38d0 
This is in addition to doing it on merge to main, which will update the
dev docs and for any released version.
@dopplershift
CI: Add environment to upload to PyPI
daf7d6c 
Set things up to use a GitHub environment for uploading to PyPI. This
treats the upload to PyPI as a deployment, and restricts the PyPI token
to this environment. Ideally, this would allow us to restrict the
environment to our tagged releases, but unfortunately the "branch
filter" rules only work on branches, not tags.

This was motivated by CodeCov having a security breach. Our PyPI token
doesn't seem to be at risk, but it was rotated anyway and this seems
like a nice extra layer to put in the way of it accidentally being
exposed/used.
@dopplershift
CI: Tweak draft release action
5251a43 
Releases can now optionally create a discussion topic when they are
published, so go ahead and set that up when drafting the release.
@dopplershift
CI: Make sure flake8 erroring fails the workflow
7f568d1 
Need to enable pipefail so that if flake8 crashes, bash sets that as
the error state.
@dopplershift
DOC: Fix formula rendering in some docstrings
af59eef 
Using relative_humidity in a formula makes for some bad latex
equations--use rh instead.
@dopplershift
DOC: Update the infrastructure guide
e995194 
Include informaton about the workflow managing versions on gh-pages.
@dopplershift dopplershift added this to the 1.0.1 milestone Apr 28, 2021
@dopplershift
Copy link
Member Author

Turns out that the set -o pipefail was important to discover that flake8 was actually failing in the workflow, due to a bad path in the config (flake8_metpy should have been flake8-metpy).

@dcamron dcamron merged commit fabdf83 into Unidata:main Apr 28, 2021
@dopplershift dopplershift deleted the release-docs branch April 28, 2021 22:59
@dopplershift dopplershift mentioned this pull request Apr 28, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcamron dcamron dcamron approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.0.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dopplershift @dcamron