Skip to content

Conversation

@HugoOnghai
Copy link
Collaborator

@HugoOnghai HugoOnghai commented Jul 31, 2025

adds the release workflow for our mpcite package.

it uses uv, testpypi, charmixer's auto-changelog action, mkdocs...

uv

  • uv publish is used to publish to testpypi. the keyword options will need to change when switching to pypi.
  • uv version bumping (e.g. uv version --bump patch) is left up to the user to do, before a release is published (and it should fail to publish if the version wasn't bumped)

testpypi

  • currently at https://test.pypi.org/project/mp-cite/
  • the github action is provided a write-access testpypi api token in order to uv publish. the token is scoped to only work on the mpcite project on testpypi

auto-changelog

  • follows the steps done by emmet's release workflow
  • haven't yet tested if it works

mkdocs

  • uvx mkdocs gh-deploy builds and deploys the project. no need for a deployment action to be called. pretty neat!
  • the documentation is currently hosted at (https://hugoonghai.github.io/MPCite/)

Misc... to dos...

  • As of making this PR, the workflow will also run when the release-workflow branch is pushed. this is need to be changed later
  • idk how to actually make a release yet so I will figure this out soon too

HugoOnghai and others added 29 commits August 4, 2025 17:24
@tsmathis tsmathis merged commit 401b6b1 into materialsproject:master Aug 5, 2025
0 of 3 checks passed
@tsmathis tsmathis mentioned this pull request Aug 6, 2025
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.

2 participants