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

👷‍♂️Refactor CI and Release Workflows to Improve Robustness and Efficiency #271

Merged
merged 12 commits into from
Aug 7, 2021

Conversation

TeoZosa
Copy link
Owner

@TeoZosa TeoZosa commented Aug 7, 2021

Improves CI build maintainability and readability via better code isolation and intra-workflow job colocation, which in turn improve:

  • reliability via race condition preemption
  • efficiency and correctness via direct coupling of dependent jobs through needs dependency specification field and leveraging direct variable passing functionality afforded by the aforementioned, respectively

Decouple publication of release notes from package build & upload jobs.
@TeoZosa TeoZosa added build Changes that affect the build system or external dependencies ci Changes to CI configuration files and scripts cookiecutter Changes outside of the template directory github_actions Pull requests that update Github_actions code labels Aug 7, 2021
@TeoZosa TeoZosa self-assigned this Aug 7, 2021
Reduce code duplication and provide a single source of truth for version
numbers and tags.
Decoupling package building from PyPI uploading.
Better code isolation which reduces job flakiness due to inter-workflow
distributed processing errors (viz. race conditions) by eliding
busy-waiting on Release workflow completion and explicitly synchronizing
the package-under-test version between the `pypi-packages-upload` and
`verify-user-install` jobs.
Reuse code for greater efficiency, maintainability, and further
resilience to job flakiness due to inter-job race conditions.
@TeoZosa TeoZosa force-pushed the refactor-ci-and-release-workflows branch from 8b3c18e to 63cfbec Compare August 7, 2021 01:10
@TeoZosa TeoZosa merged commit 3234dac into master Aug 7, 2021
@TeoZosa TeoZosa deleted the refactor-ci-and-release-workflows branch August 7, 2021 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Changes that affect the build system or external dependencies ci Changes to CI configuration files and scripts cookiecutter Changes outside of the template directory github_actions Pull requests that update Github_actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant