-
Notifications
You must be signed in to change notification settings - Fork 29
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
Automated publishing, Makefile cleanup, Black, improved release instructions #286
base: main
Are you sure you want to change the base?
Conversation
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.
4a080a3
to
bbea37f
Compare
zest-releaser is sort of useful, but we don't use it much for other repositories and is thus unfamiliar to most.
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. |
We are now using ReadTheDocs for this exclusively.
@laymonage I suppose you are right and we don't need Vercel anymore. I've removed the integration. |
Attempts to declutter the project and ease maintenance.
Makefile
which I believe are rarely used. Less is better.Remove the Github Pages deployment, this does not appear to be usedactually used to build the thelatest
version on Read the Docszest.releaser
. (which provides theprerelease
andpostrelease
commands 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)