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

Chore/metadata #555

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Chore/metadata #555

merged 2 commits into from
Feb 21, 2024

Conversation

JP-Ellis
Copy link
Contributor

📝 Summary

Update to the project metadata. Specifically:

  • Adding myself as an author (as I am writing pact.v3 which will ultimately become Pact Python v3)
  • Use Git in order to determine the current version of Pact Python. This works by looking for tags of the form vX.Y.Z and also support dev versions of the form vX.Y.Z.devN (where N indicates the number of commits since the tag).

🚨 Breaking Changes

  • The __version__ tag is now a different format.

🔥 Motivation

This is a minor update which should hopefully improve the development lifecycle (especially the dev versioning).

🔨 Test Plan

None

🔗 Related issues/PRs

None

The `hatch-vcs` is an extension to hatch's build system which
automatically determines the current version of the project based on the
VCS (i.e., git in this instance).

Specifically, it looks for the latest `vX.Y.Z` tag and:

- If the current `HEAD` is identical to the tag, sets a nice 'clean'
  version;
- If the current `HEAD` is infront of the tag, uses a dev build
  versioning of the form `vX.Y.Z.devN` where `N` is the number of
  commits between `HEAD` and the tag.

Signed-off-by: JP-Ellis <josh@jpellis.me>
Given I have written the `v3` submodule, I have added myself into the
list of authors.

Signed-off-by: JP-Ellis <josh@jpellis.me>
@JP-Ellis JP-Ellis merged commit b74e549 into master Feb 21, 2024
32 of 38 checks passed
@JP-Ellis JP-Ellis deleted the chore/metadata branch February 21, 2024 09:54
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.

1 participant