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.

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Stormheg
Copy link
Member

@Stormheg Stormheg commented Mar 7, 2024

Attempts to declutter the project and ease maintenance.

  • Remove a lot of targets from the Makefile which 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 latest version 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 the prerelease and postrelease 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)

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.
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.
@Stormheg
Copy link
Member Author

Stormheg commented Mar 7, 2024

I've just set up the Trusted Publisher in the PyPI interface.

@Stormheg
Copy link
Member Author

Stormheg commented Mar 7, 2024

I'm not sure why Vercel is failing. I don't have access and cannot view the logs.

@Stormheg Stormheg marked this pull request as ready for review March 7, 2024 17:49
@Stormheg Stormheg linked an issue Mar 7, 2024 that may be closed by this pull request
@Stormheg
Copy link
Member Author

Stormheg commented Mar 8, 2024

I stumbled on #226 (comment) 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.

@laymonage
Copy link
Member

@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.

@lb-
Copy link
Member

lb- commented Mar 10, 2024

Thanks both for making this better.

We are now using ReadTheDocs for this exclusively.
@Stormheg
Copy link
Member Author

Stormheg commented Mar 20, 2024

@laymonage I suppose you are right and we don't need Vercel anymore. I've removed the integration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate release process
3 participants