Skip to content

Add deploy workflow #971

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
May 21, 2020
Merged

Add deploy workflow #971

merged 2 commits into from
May 21, 2020

Conversation

waylan
Copy link
Member

@waylan waylan commented May 20, 2020

TODO:

  1. Create auth tokens for PyPI and GH Pages.
  2. Test this. Maybe do a test with TestPyPI and/or an alpha release???
  3. Update Release Process in the Contributing Guide (this replaces steps 8 & 9).

Notes:

I'm using pypa/gh-action-pypi-publish because that action is officially part of PyPA and documented in the PyPA Guide (I didn't even look at other options).

Of the many GitHub Pages deployment actions to choose from I chose peaceiris/actions-gh-pages for a few reasons:

  1. As we are using org pages, we don't deploy to the same repo. It was not clear to me how to do that directly with mkdocs gh-deploy. We would need to checkout two repos, and deploy to the one while referencing the working files from the other (see step 9 of the Release Process).
  2. This action officially supports and documents using external repos with public/private deploy keys (note: public key gets saved to Python-Markdown/Python-Markdown.github.io and private key to Python-Markdown/markdown). The documentation for any other actions I looked at didn't mention how to do this, even if they appeared to have a config option for it.
  3. This action also specifically provides a MkDocs Example in the documentation (among many other static site generators), which suggests continued support.
  4. The action was one of the few highly rated ones (893 stars at time of publishing).

@waylan waylan added process Discussions regarding policies and development process. work-in-progress A partial solution. More changes will be coming. labels May 20, 2020
@waylan waylan removed the work-in-progress A partial solution. More changes will be coming. label May 21, 2020
@waylan
Copy link
Member Author

waylan commented May 21, 2020

The only way to test this is to commit it and then tag a release. I guess testing it will have to wait. Fortunately, the way I edited the request process in the docs we retain the manual method as a fallback.

@waylan waylan merged commit b7d6429 into Python-Markdown:master May 21, 2020
@waylan waylan deleted the deployworkflow branch May 21, 2020 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process Discussions regarding policies and development process.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant