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

Post a PR comment when semver is violated #636

Open
MarcoIeni opened this issue Mar 22, 2023 · 1 comment
Open

Post a PR comment when semver is violated #636

MarcoIeni opened this issue Mar 22, 2023 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed priority:medium We care about this

Comments

@MarcoIeni
Copy link
Owner

MarcoIeni commented Mar 22, 2023

Motivations

Right now release-plz analyzes semver violations on the main branch and bumps the version accordingly. But having a semver violation committed to main might be already too late!

Solution

We want to post a PR comment when there's a semver violation.
The maintainer is free to merge the PR, but they have been warned :)

Why doing this in release-plz and not in another github action? because we want to rely on the config file we are going to implement soon.

This workflow should be added to the

on:
  pull_request:

in github actions.

We should add a command called "review". E.g. release-plz review <pr_link>.

Question

  • Is there a convenient way to add this to the cargo-semver-check action, too?
@MarcoIeni MarcoIeni added the enhancement New feature or request label Mar 22, 2023
@MarcoIeni MarcoIeni added the priority:medium We care about this label Apr 5, 2023
@MarcoIeni MarcoIeni added the help wanted Extra attention is needed label Feb 14, 2024
@MarcoIeni
Copy link
Owner Author

To avoid being too spammy, we should only post the commit when semver checks detects a breaking change in the changed lines of the PRs.
If a line was deleted or edited and a breaking change was detected that, then let's post thr comment.

Btw we should also post the comment if semver is respected, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed priority:medium We care about this
Projects
None yet
Development

No branches or pull requests

1 participant