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

Minor, mostly packaging, clean-ups #1900

Merged
merged 4 commits into from
Mar 11, 2022

Conversation

joshuagl
Copy link
Member

@joshuagl joshuagl commented Mar 9, 2022

Pulls a bunch of fixes suggested by @ofek from #1896

Description of the changes being introduced by the pull request:

  • Utilise tox isolated builds
  • Fix gitignore directory patterns
  • Remove redundant comment about version in tuf/__init__.py
  • Remove upper bound limit on python_requires in setup.cfg

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

joshuagl and others added 4 commits March 9, 2022 11:53
The version is no longer duplicated in setup.cfg (since 5155ba7), so remove
redundant TODO suggesting folks update in two places.

Co-authored-by: Ofek Lev <[email protected]>
Signed-off-by: Joshua Lock <[email protected]>
Enable tox isolated environments to perform build operations in a virtual
environment.
See https://tox.wiki/en/latest/config.html#conf-isolated_build

Co-Authored-By: Ofek Lev <[email protected]>
Signed-off-by: Joshua Lock <[email protected]>
Setting upper bound version constraints in libraries is a source of
problems for users of those libraries, see:
https://iscinumpy.dev/post/bound-version-constraints/

The intent of the python-tuf version constraint is to ensure we're
using a version of Python which supports all the features we rely
on, this is a better fit for a lower limit.

Suggested-by: Ofek Lev <[email protected]>
Signed-off-by: Joshua Lock <[email protected]>
Fix the directory ignore patterns to ignore the entire directories,
including child directories.
https://git-scm.com/docs/gitignore#_pattern_format

Co-authored-by: Ofek Lev <[email protected]>
Signed-off-by: Joshua Lock <[email protected]>
@coveralls
Copy link

Pull Request Test Coverage Report for Build 1958010688

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.311%

Totals Coverage Status
Change from base Build 1944527064: 0.0%
Covered Lines: 1178
Relevant Lines: 1194

💛 - Coveralls

Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

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

Great fixes, thanks. I disagree with the reasoning for python_requires change: The case made in the linked blog post applies to libraries, and in that case I agree completely. In the case of python we absolutely know that if there ever is a Python 4, it's going to be a breaking change (a new ecosystem in a sense).

I'll approve this anyway, preparation for Python 4 might not be the thing to argue about 😂

@jku jku merged commit 8ac7167 into theupdateframework:develop Mar 11, 2022
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.

4 participants