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

Document PyScaffold "Short"-Term Support Policy. #537

Open
FlorianWilhelm opened this issue Oct 31, 2021 · 5 comments
Open

Document PyScaffold "Short"-Term Support Policy. #537

FlorianWilhelm opened this issue Oct 31, 2021 · 5 comments
Labels
documentation Improvements, additions and corrections to documentation good first issue Good for newcomers

Comments

@FlorianWilhelm
Copy link
Member

FlorianWilhelm commented Oct 31, 2021

Since there is already PyScaffold 4.1, we should think about when we officially slate PyScaffold 3.* as no longer supported. Maybe we should even be removing the part in the docs mentioning PyScaffold 2.* for Python 2 projects as hopefully no one is starting new Python 2 projects anymore.

@abravalheri abravalheri added documentation Improvements, additions and corrections to documentation future Related to an upcoming PEP or future development good first issue Good for newcomers labels Oct 31, 2021
@abravalheri
Copy link
Collaborator

Historically we have been maintaining the latest major version behind as kind of courtesy "LTS" policy, right?

What makes me think about v5... the initial plan was to wait for PEP 621 to land on setuptools, which I though would happen in the middle of this year. But I really overestimated the willingness of the community to contribute to that project (or underestimated the complexity of the code 😝).

If we want to keep the same courtesy "LTS" policy, but drop the PEP 621 requirement for v5, that could be planned...

@FlorianWilhelm
Copy link
Member Author

Historically we have been maintaining the latest major version behind as kind of courtesy "LTS" policy, right?

That's right, I just wonder (and am completely open about all directions) if we should have some kind of rule of thumb. This could be

  1. (status quo): The latest two major version branches are supported.
  2. (time based): After a major version is superseded by the next major version, there is a transition period of N years.
  3. (minor version): With the first increment of the minor version the previous major version is deprecated. So with 4.1 we would deprecate the 3.* branch.

My gut feeling says that 2. could be a viable option.

@abravalheri
Copy link
Collaborator

abravalheri commented Oct 31, 2021

How about whatever happens first between 1 and 2, with N=1 year? 😝

@FlorianWilhelm
Copy link
Member Author

How about whatever happens first between 1 and 2, with N=1 year? 😝

Sounds good!

@abravalheri abravalheri changed the title Lifetime of PyScaffold 3.* branch Document PyScaffold "Short"-Term Support Policy. Oct 31, 2021
@abravalheri
Copy link
Collaborator

Just a minor comment: this should not affect the users too much because of the following aspects:

  • PyScaffold usage is mostly "one shot"
  • It's not a runtime dependency
  • We currently provide either automatic "update" or at least instructions for manual update

@abravalheri abravalheri removed the future Related to an upcoming PEP or future development label Oct 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements, additions and corrections to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants