ci: add downstream impact checkbox to PR template#83
Merged
Conversation
Flags PRs that change public bankstatements_core interfaces so the private repo knows to update before consuming the next core release. Part of longieirl/bankstatements#189 Part 2.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Downstream impact section to the PR template with a checkbox for PRs that change public
bankstatements_coreinterfaces.Why
The private
longieirl/bankstatementsrepo consumesbankstatements-corefrom PyPI. When a public interface changes (exported class, function, or exception), the premium code may need updating before the next core release lands. Without a signal on the PR, this dependency is invisible until CI breaks.How it works
When the checkbox is checked, the PR author describes what changed and what the private repo needs to update. Combined with a
breaking-downstreamlabel (to be added as a repo label), these PRs are searchable and reviewable before the core version is published.Changes
.github/PULL_REQUEST_TEMPLATE.md— add Downstream impact sectionCloses Part 2 of longieirl/bankstatements#189 (public-repo task).