Automated publishing, Makefile cleanup, Black, improved release instructions #286
Conversation
Stormheg
force-pushed
the
chore/various-cleanup
branch
from
4a080a3 to
bbea37f
Compare
Stormheg
force-pushed
the
chore/various-cleanup
branch
from
bbea37f to
5fda8f1
Compare
|
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 #226 (comment) which mentions that the 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. |
We don't appear to use this.
Looks like a smoke test to check the sphinx build process does not crash. We can do this in a way the can more easily run locally.
We used this for the sphinx-quickstart and github actions deploy.
Use Node 20 instead of 16, because actions using v16 are deprecated. https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/
Not sure why we had a lint-minimal tasks. Code is either linted or not. There is no in-between lower standard.
This action supports caching and is one less moving part to worry about.
.github/workflows/publish.yml
Outdated
| types: [released] | ||
| jobs: | ||
| test: | ||
| uses: ./.github/workflows/co.yml |
There was a problem hiding this comment.
| uses: ./.github/workflows/co.yml | |
| uses: ./.github/workflows/ci.yml |
zest-releaser is sort of useful, but we don't use it much for other repositories and is thus unfamiliar to most.
We are now using ReadTheDocs for this exclusively.
laymonage
force-pushed
the
chore/various-cleanup
branch
from
4ac300b to
1ca6e37
Compare
Attempts to declutter the project and ease maintenance.
Makefilewhich I believe are rarely used. Less is better.Remove the Github Pages deployment, this does not appear to be usedactually used to build the thelatestversion on Read the Docszest.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)