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

Add stub script for compatibility-labelling PRs #22

Merged
merged 1 commit into from
Nov 29, 2023

Commits on Nov 29, 2023

  1. Add stub script for compatibility-labelling PRs

    This is a stub script that doesn't actually output true compatibility
    information, it's just a demonstration showing what kind of behaviour
    would be desirable.
    
    It's aiming to show the part 1 of the workflow described in
    scalacenter/sbt-version-policy#179:
    
    > **Keep devs aware of the compatibility of the PR they're working on** : When a PR is opened on a library repository, an automated workflow comments-on or labels the PR, making them aware that _"This PR breaks binary/source compatibility"_ - the information here would come from the `sbt-version-policy` plugin, but wouldn't require setting a `versionPolicyIntention` - it just establishes _what_ the level of compatibility the PR entails, so that the developer is aware. The assumption here is that whatever the developer is doing, they need to do it, and should just know the compatibility cost the PR is going to have (and possibly, though not necessarily, once informed they may be able to modify the PR to improve the compatibility).
    
    The script is written to add-and-remove labels as appropriate, if
    the required compatibility label (eg 'Breaks Binary Compatibility') wasn't already
    present, we assume this is new information and leave a detailed comment.
    In general, to reduce noise, we wouldn't necessarily want to add a new
    comment on every push, better to just tell the user how they can get this
    information by running locally...
    rtyley committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    a72edce View commit details
    Browse the repository at this point in the history