-
Notifications
You must be signed in to change notification settings - Fork 8
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
Add lock file #141
base: main
Are you sure you want to change the base?
Add lock file #141
Conversation
Vulnerability scanning tooling is using the lock file to look for issues. Without this, the tooling will not be able to produce reliable report.
Pre commit hook helps the developers execute some tasks before committing.
You’ll need to update the changelog. Minor release.
|
We are using python 3.11 in github check for requirements lock. Predictable version in the local precommit makes the CI job reliable.
Added. |
CHANGELOG.rst
Outdated
Version 15.6 | ||
============ | ||
|
||
* Added requirements lock file that is automatically generated with tox and pre-commit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
requirements.txt seems not used anywhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or how is the vulnerability scanner configured to use the lockfile? Either way if it's only used by CI and not even included in the published python package I don't think a changelog is needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I asked for one to track these changes in case some external dev runs into them. As we often have externals making PRs on this repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The requirements.txt is used by the Aikido app integration and hence will not be visible here. And, the changelog is added as @Aerylia asked for it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is requirements.txt part of the published python package?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well perhaps it doesn't matter but I'd consider leaving it out to avoid confusion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think, we should remove the changelog entry? I am positive about it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, it can be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reverted. We can squash the commits while merging to make it clean.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see any benefit for having this lockfile if the python package and CI are not using it. I think we should either make the package depend on the lockfile - although for client libraries this wouldn't make much sense and would actually be a big nuisance for runtimes depending on this library - or simply ignore this aikido complaint which I think is correct for client library repos.
This reverts commit bae0a3e.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the lock file check in the CI.
We cannot guarantee that the lock file remains same in the lifetime. Hence, removing the checks here.
Vulnerability scanning tooling is using the lock file to look for issues. Without this, the tooling will not be able to produce reliable report.