NWChemEx / NWChemEx/.github

Use git versions instead of version.txt

Open
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
1
Forks
2
Avg merge
22m
Merged PRs (30d)
4

Description

This needs to happen all over the project. Basically we now have GitHub actions which will automatically tag master after a PR. We should be using the version information from those tags in, for example, the main CMakeLists.txt and in the config.py for the documentation.

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

Review the GitHub Actions that tag master, then inspect version.txt references in the main CMakeLists.txt and config.py. Trace how version information is currently read across the project. Done means the project uses the Git tag version instead of version.txt, including the named build and documentation configuration files.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, git, github-actions, python
Domain
build-system, ci-cd, documentation, release
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.