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

Feature: Remove requirements.txt and use pipenv everywhere #1316

Merged
merged 1 commit into from
Aug 1, 2022

Conversation

stumpylog
Copy link
Member

Proposed change

This PR removes the requirements.txt file and instead changes the Docker image and CI steps to all use pipenv.

This is mostly so dependencies are not managed in 2 places and also means dependabot will be more useful, as it no longer updates both requirements.txt and Pipfile.lock.

I compared the release zip and everything matched locations after the changes made to the release steps. These changes where required so pipenv wouldn't need create a .venv twice, for the checked code folder and again for the dist folder.

Finally, to ensure backwards compatibility with all the docs and previous releases, a requirements.txt is still generated and included as part of the release package.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (please explain)

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@stumpylog stumpylog requested review from a team as code owners July 31, 2022 19:17
@paperless-ngx-secretary paperless-ngx-secretary bot added backend ci-cd non-trivial Requires approval by several team members labels Jul 31, 2022
@shamoon
Copy link
Member

shamoon commented Aug 1, 2022

Yea the dependabot issue has been pretty annoying, this is great thanks as always!

Copy link
Member

@qcasey qcasey left a comment

Choose a reason for hiding this comment

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

Thanks!

@qcasey qcasey merged commit 0d23b33 into dev Aug 1, 2022
@qcasey qcasey deleted the feature-docker-pipenv branch August 1, 2022 01:47
@bauerj
Copy link
Member

bauerj commented Aug 1, 2022

Nice!

@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backend ci-cd non-trivial Requires approval by several team members
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants