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.

Sign up for GitHub

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

Add note on tags to CONTRIBUTING.rst #10407

Merged
merged 2 commits into from
Oct 21, 2022
Merged

Add note on tags to CONTRIBUTING.rst #10407

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b905ee
Add note on tags to CONTRIBUTING.rst
NateMeyvis Oct 21, 2022
1027dc8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,11 @@ Here is a simple overview, with pytest-specific bits:
be released in micro releases whereas features will be released in
minor releases and incompatible changes in major releases.

You will need the tags to test locally, so be sure you have the tags from the main repository. If you suspect you don't, set the main repository as upstream and fetch the tags::
Copy link
Member

Choose a reason for hiding this comment

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

To confirm: is that because of setuptools-scm, or something else?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, without the tags, the version was showing like 0.1.dev123+xyz. See the pytest Discord where we debugged this: https://discord.com/channels/810210251398840371/810245251502964736/1033019899670437998

Copy link
Member

Choose a reason for hiding this comment

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

Thanks!


$ git remote add upstream https://github.com/pytest-dev/pytest
$ git fetch upstream --tags

If you need some help with Git, follow this quick start
guide: https://git.wiki.kernel.org/index.php/QuickStart

Expand Down