Repository navigation
Create a new release
MITE follows a rolling release cycle, with approximately monthly releases (depending on the number of submission and review speed). Releases are created by one of the maintainers, who first create a new release in the mite_data GitHub repository.
Additionally, a new release also needs to be created in this repository. Why? Because this repository contains additional data artifacts that do not belong into mite_data but are required for the MITE webpage (e.g. protein renderings). This makes the webpage run much smoother.
Nota bene: this tutorial assumes that you have maintainer rights and that you have just created a new mite_data release and come from the Wiki page
Go to the Actions tab and select Prepare release
Hit Run workflow. This will automatically update all artifacts and create a new pull request (PR). This process can take a few minutes and must pass. If if fails, investigate, fix, and repeat.
The PR should have no conflicts with the base branch. Check again (e.g. are the changes done in mite_data also reflected there) and investigate if anything seems off (but usually, all should be fine).
Only if the workflow has successfully passed, you can start preparing the release. Modify the following files (e.g. using the GitHub GUI)
-
pyproject.toml: update the version (only minor; e.g. 1.x). This mirrors the mite_data version -
CHANGELOG.md: update the changelog and describe the new release
Then, prepare the new release using the GitHub GUI
Once the release is prepared, it is automatically grabbed and archived by Zenodo. Go check if the release has been synced (if not, there is likely an issue with the metadata - investigate). Now, the mite_data release is ready to be put online. For that, notify the current MITE Website administrator, who will create a new build of the MITE Website.