Skip to content

manually set version to current MDA release 2.10.0#155

Closed
orbeckst wants to merge 5 commits into
mainfrom
version-updated
Closed

manually set version to current MDA release 2.10.0#155
orbeckst wants to merge 5 commits into
mainfrom
version-updated

Conversation

@orbeckst

@orbeckst orbeckst commented Feb 2, 2026

Copy link
Copy Markdown
Member

Related to #141

Changes made in this Pull Request:

  • manually set the version to the current MDAnalysis release (2.10.0)

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG.md updated?
  • AUTHORS.md updated?
  • Issue raised/referenced?

Comment thread cookiecutter.json Outdated
@ojeda-e

ojeda-e commented May 1, 2026

Copy link
Copy Markdown
Member

I looked for more details here, and definitely the quotes for mda version is not the root of the problem. It traces back to the file docs/scripts/generate_cookiecutter_cli.py and the shutil.copytree in it:

source_repo = os.path.join(tmpdir, self.repo_name)
destination_repo = str(self.example_repo_path.resolve())
shutil.rmtree(destination_repo, ignore_errors=True)
shutil.copytree(source_repo, destination_repo)

As an attempt to find a reference, I checked and the generate_cookiecutter_cli.py -I didn't even know there was a CLI for this-. But the file doesn't exist in the modern version of the cookiecutter, so hard to tell without further details. I could offer to investigate this, although it may take me some time, fixing this is an issue/PR in itself IMO.

@orbeckst

orbeckst commented May 1, 2026

Copy link
Copy Markdown
Member Author

This script was added by us, see https://github.com/MDAnalysis/cookiecutter-mdakit/blame/main/docs/scripts/generate_cookiecutter_cli.py@lilyminium to be precise. I don't know what these scripts are doing.

@ojeda-e

ojeda-e commented May 2, 2026

Copy link
Copy Markdown
Member

After more investigation, I opened an issue with a detailed description of what I found:

If there are no objections, I can work on this.

orbeckst and others added 3 commits May 4, 2026 16:49
@orbeckst

orbeckst commented May 8, 2026

Copy link
Copy Markdown
Member Author

This PR does not really fix #141 but just changes the number to something somewhat more sensible in the meantime.

@orbeckst

Copy link
Copy Markdown
Member Author

Ping @lilyminium @IAlibay @p-j-smith (cookiecutter team) — are you ok with at bumping the recorded/displayed version of the cookiecutter to the current MDA release? Or would you rather we remove it completely although I haven't looked where it plays a role and I probably won't be able to invest a lot of time into this PR.

@lilyminium

lilyminium commented May 25, 2026

Copy link
Copy Markdown
Member

Sorry for the delay, I was away on my honeymoon and couldn't figure out if GitHub had vacation settings! When we/I set this up we intended the cookiecutter to be versioned separately to MDA proper as we anticipated MDA being updated in accordance to new science/functionality and the cookiecutter to be updated in accordance to best practices in Python development, which moves a bit slower. Updating the cookiecutter every time the core library gets updated is a bit of additional work, whereas I think removing versioning largely keeps things the same, so I would vote for the latter over the former.

Is anything actively breaking at the moment from the version mismatch?

@lilyminium

lilyminium commented May 25, 2026

Copy link
Copy Markdown
Member

@ojeda-e I see you and @orbeckst resolved this already -- thank you both! -- but just for posterity, that script auto-generates this part of the documentation and actually runs a cookiecutter to ensure that the input/output options and tree are accurate:

Screenshot 2026-05-25 at 11 05 04 am

@orbeckst

Copy link
Copy Markdown
Member Author

Is anything actively breaking at the moment from the version mismatch?

I don't think so. It's just that the version number 0.1 is baked into the docs of every single MDAKit that uses it and it conveys no information (or is confusing because it may seem that nothing in the cookiecutter changed).

I am also not fully convinced that using the latest MDA version is particularly helpful, except in that we have an idea that it worked with it. For right now, I'll close the PR and we can decide on the issue #141 how to proceed.

@orbeckst orbeckst closed this May 25, 2026
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.

3 participants