Materials-Consortia / Materials-Consortia/optimade-python-tools

Zenodo release archives miss out changelog and version

Open
#1,699 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Because of the way we automatically move release tags after regenerating docs, the Zenodo archives are constantly out of date. This is maybe not a big deal, but perhaps could be circumvented using GitHub's draft release feature in future.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the automated documentation regeneration and release-tag process, then inspect how Zenodo archives are created from those tags. Done means a release archive contains the changelog and version and is not left out of date after documentation regeneration.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.