Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use setuptools-scm for package version #18

Merged
merged 1 commit into from
Feb 25, 2024
Merged

Conversation

ryanpdx
Copy link
Member

@ryanpdx ryanpdx commented Feb 24, 2024

This change will generate the package version based off of git tags and git comments. This will help identify which cards on FlatSat are using a unreleased version of oresat-config during integration / testing.

If the package is built of a tagged commit the version will match the tagged version, if the package is built of a non-tagged commit it will include the last tagged version, start of the commit hash, and the date; e.g.: 0.3.2.dev9+g9afbd58.d20240224.

Also, we don't have to worry about updating __version__ when tagging a commit.

@ryanpdx ryanpdx added the enhancement New feature or request label Feb 24, 2024
Copy link
Contributor

@ThirteenFish ThirteenFish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good feature, I try to do something like this in my personal projects as well.

I've got just a couple minor notes on satisfying the linters.

oresat_configs/constants.py Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@ThirteenFish ThirteenFish merged commit 523f11b into master Feb 25, 2024
1 check passed
ThirteenFish added a commit that referenced this pull request Feb 26, 2024
This incorporates the changes from PRs #16, #17, and #18. This branch
was originally based on #16 before feedback.

I don't believe this introduces any new behavior
@ryanpdx ryanpdx deleted the better-versioning branch February 28, 2024 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants