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

[157] Refactor of build processes and dependency management using Poetry #261

Merged
merged 1 commit into from
Apr 25, 2024

Conversation

borland667
Copy link
Contributor

@borland667 borland667 commented Apr 16, 2024

What?

Files Added

  • Introduced .coveragerc to centralize the coverage configuration.
  • New entry script entrypoint.sh added for better container initialization.

Files Updated

  • GitHub Workflows Adjusted:
    • release-pypi-build-push-package.yml, release-pypi-build-push-test-package.yml, tests-integration.yaml, and tests-unit.yml updated to improve CI/CD pipelines using Poetry.
  • Dockerfile and Makefile:
    • Changes in the Dockerfile and Makefile to optimize build processes and integrate with new CI/CD setup.
  • Configuration Files:
    • pyproject.toml and poetry.lock updated to use Poetry for dependency management, reflecting new dependencies and configurations.
    • Transitioned coverage settings from setup.cfg (now deleted) to .coveragerc.

Files Removed

  • Removed Pipfile and Pipfile.lock as part of the move to Poetry.
  • Deleted old dev-specific requirements file dev-requirements.txt.
  • Removed setup.cfg and minimized setup.py, streamlining project setup and reducing redundancy.

Why?

  • Enhanced Project Configuration and Simplification:
    • Centralizing configuration settings like coverage under .coveragerc simplifies modifications and updates, enhancing maintainability.
    • Removing redundant configuration files (Pipfile, Pipfile.lock, setup.cfg) reduces clutter and focuses on using Poetry, which supports contemporary Python project standards.
  • CI/CD Pipeline Improvements:
    • Updated workflow files to integrate with Poetry, improving build and test pipeline reliability and performance.
    • New entry script and adjustments in Dockerfile/Makefile prepare the project infrastructure for more robust and scalable deployments.
  • Adherence to Modern Best Practices:
    • Transition to Poetry for dependency management aligns with the latest practices in Python software development, aimed at improving project setup, dependency resolution, and package management.

References

Before Release

Review the checklist here.

@borland667 borland667 force-pushed the 157-dependencies branch 8 times, most recently from 2d93f3b to 7f80631 Compare April 17, 2024 00:27
@coveralls
Copy link
Collaborator

coveralls commented Apr 17, 2024

Pull Request Test Coverage Report for Build 8744098066

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+9.9%) to 69.031%

Totals Coverage Status
Change from base Build 8744072155: 9.9%
Covered Lines: 2018
Relevant Lines: 2812

💛 - Coveralls

@borland667 borland667 force-pushed the 157-dependencies branch 5 times, most recently from 188c313 to c1c3575 Compare April 17, 2024 14:26
@borland667 borland667 self-assigned this Apr 17, 2024
README.md Outdated Show resolved Hide resolved
tests/bats/leverage_terraform.bats Outdated Show resolved Hide resolved
@borland667 borland667 changed the title [157] Avoid having multiple sources for dependencies [157] Refactor of Build Processes and Dependency Management Using Poetry Apr 17, 2024
@borland667 borland667 changed the title [157] Refactor of Build Processes and Dependency Management Using Poetry [157] Refactor of build processes and dependency management using Poetry Apr 17, 2024
@borland667 borland667 force-pushed the 157-dependencies branch 2 times, most recently from de62195 to 2b4c640 Compare April 17, 2024 20:40
@borland667 borland667 linked an issue Apr 17, 2024 that may be closed by this pull request
4 tasks
@borland667 borland667 force-pushed the 157-dependencies branch 4 times, most recently from 6c080b0 to 81d2a52 Compare April 18, 2024 14:51
* update poetry install action
* update poetry install method
* update unit tests pipeline
* update makefile test command
* update unit test workflow
* run unit tests with multiple python versions
* cleanup files & update Makefile
* update dependency installation with poetry for integration tests
* update unit test workflow
* update release workflows
* update docs
* fix typo
* remove verbose argument in terraform integration tests
* update toolbox image version
* fix build command
* add supported python versions & doc
* update poetry lock file
* add support for python 3.11
* update docs
Copy link
Contributor

@angelofenoglio angelofenoglio left a comment

Choose a reason for hiding this comment

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

It does seem that nothing got lost in the switch. The new sections in the README look nice!

@borland667 borland667 merged commit daab988 into master Apr 25, 2024
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request patch
Projects
None yet
3 participants