sphinx-wagtail-theme
sphinx-wagtail-theme copied to clipboard
Automated publishing, Makefile cleanup, Black, improved release instructions
Attempts to declutter the project and ease maintenance.
- Remove a lot of targets from the
Makefilewhich I believe are rarely used. Less is better. - ~~Remove the Github Pages deployment, this does not appear to be used~~ actually used to build the the
latestversion on Read the Docs - Add Trusted Publishing and trigger PyPI releases from a GitHub release. Meaning anyone with maintainer access to this repository can make releases. No need for PyPI tokens.
- Check linting of Javascript/CSS files in CI
- Add Black - there is not much Python code in this library but it is nice to have consistency.
- Remove
zest.releaser. (which provides theprereleaseandpostreleasecommands mentioned in the original documentation). We don't use tools like this much in other projects and I think it is best to just remove it (for consistency and to avoid confusion)
I've just set up the Trusted Publisher in the PyPI interface.
I'm not sure why Vercel is failing. I don't have access and cannot view the logs.
I stumbled on https://github.com/wagtail/sphinx-wagtail-theme/issues/226#issuecomment-1462422734 which mentions that the latest version on read the docs is actually built from the gh-pages. Removing the GitHub Pages build from the CI will break that integration
Looks like I'll have to consider if there is an alternate way of building the latest version of the theme, or bring back the Pages build.
@Stormheg I fixed the readthedocs config to also build the frontend assets in #284, so I think that might be irrelevant now. I suppose the reason why we had the Vercel setup was also because we didn't have the setup to build the frontend assets for PR builds on readthedocs. Now that it's been fixed, we can probably remove both of them.
Thanks both for making this better.
@laymonage I suppose you are right and we don't need Vercel anymore. I've removed the integration.