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 scm setuptools for auto-versionning #4401

Merged

Conversation

Pierre-Sassoulas
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas commented Apr 25, 2021

Description

Move to scm_setuptools for easier release. Update the release doc.

Type of Changes

Type
✨ New feature
🔨 Refactoring
📜 Docs

Related Issue

#4399 #4400

Copy link
Member

@cdce8p cdce8p left a comment

Choose a reason for hiding this comment

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

Tbh I'm not too familiar with setuptools_scm. If you think it will make things easier, go for it.

setup.cfg Show resolved Hide resolved
@Pierre-Sassoulas
Copy link
Member Author

Basically it removes the need to change the version and is based on tags only. So no more change to do in the version value before and after release.

@wj-Mcat
Copy link

wj-Mcat commented Apr 25, 2021

Wating for this pr to be merged so my github ci can pass 👻

@Pierre-Sassoulas
Copy link
Member Author

I don't understand @wj-Mcat ? Why would it fix your CI ?

@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.8.2 milestone Apr 26, 2021
@Pierre-Sassoulas Pierre-Sassoulas changed the base branch from 3.0.0.alpha to master April 26, 2021 10:05
@Pierre-Sassoulas Pierre-Sassoulas changed the title Use scm setuptools for auto-versionning Draft: Use scm setuptools for auto-versionning Apr 26, 2021
@Pierre-Sassoulas
Copy link
Member Author

@cdce8p I think we can do that in 2.8 directly and we don't have to change the tags either, scm_setuptools seems to understand the tag.

@Pierre-Sassoulas Pierre-Sassoulas changed the title Draft: Use scm setuptools for auto-versionning Use scm setuptools for auto-versionning Apr 26, 2021
@cdce8p
Copy link
Member

cdce8p commented Apr 26, 2021

@cdce8p I think we can do that in 2.8 directly and we don't have to change the tags either, scm_setuptools seems to understand the tag.

Not exactly sure what you mean here. In my experience the tag is usually just something like v1.x.x, but if the current naming schema works there is no reason to change it.

@Pierre-Sassoulas
Copy link
Member Author

Not exactly sure what you mean here.

I wanted to change the tag from pylint-1.2.3 to v1.2.3 but the generated version by setuptool_scm is 1.2.3 for both. So we can keep the standard. We might still want to change the tag to something standard for pre-commit the version will still be pylint-1.2.3 in .pre-commitconf.yml...

@cdce8p
Copy link
Member

cdce8p commented Apr 26, 2021

Not exactly sure what you mean here.

I wanted to change the tag from pylint-1.2.3 to v1.2.3 but the generated version by setuptool_scm is 1.2.3 for both. So we can keep the standard. We might still want to change the tag to something standard for pre-commit the version will still be pylint-1.2.3 in .pre-commitconf.yml...

Ah, I see. I would recommend to use v1.2.3 then.

doc/release.md Outdated
9. Do the actual release by tagging the master with `pylint-X.Y.Z` (ie `pylint-1.6.12`
for example). Travis should deal with the release process once the tag is pushed with
`git push origin --tags`
7. Do the actual release by tagging the master with `pylint-X.Y.Z` (ie `pylint-1.6.12`
Copy link
Member

Choose a reason for hiding this comment

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

Only if you what to change the tag schema

@wj-Mcat
Copy link

wj-Mcat commented Apr 26, 2021

I don't understand @wj-Mcat ? Why would it fix your CI ?

I use pylint to test my project, but it occured error when install new version of pylint.

So, I'm waiting for this pr to be merged.

@Pierre-Sassoulas
Copy link
Member Author

Ho okay, it's actually another problem fixed in #4407 but I'm going to release 2.8.2 just after merging this one (that just speed thing up for us maintainers) so you're still right :)

@Pierre-Sassoulas Pierre-Sassoulas merged commit f9245c5 into pylint-dev:master Apr 26, 2021
@Pierre-Sassoulas Pierre-Sassoulas deleted the use-scm-setuptools branch April 26, 2021 15:38
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