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

Utilize GitHub Actions to check for SEMVER impact label #2470

Merged
merged 47 commits into from Mar 29, 2024

Conversation

KevinEyo1
Copy link
Contributor

@KevinEyo1 KevinEyo1 commented Mar 17, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Fixes #2464
Added a new workflow that runs jobs on PR closing to master branch (only if its merging in, so won't be run if PR is just closed without merging)

Anything you'd like to highlight/discuss:
Figuring how to best test this, due to limitations in regard to local testing of closing PRs

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
GitHub Actions: check impact label

It is easy to forget to label PRs with their SEMVER impact when
merging.

Adding a workflow to automate labelling will help prevent
users from missing labels when merging.

Let's check the PR body description for user selected impact,
and automatically add the label to the PR when merging.

This approach allows the user to not even have to add the label
themselves.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link

codecov bot commented Mar 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.98%. Comparing base (9da549c) to head (3fc3621).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2470   +/-   ##
=======================================
  Coverage   50.98%   50.98%           
=======================================
  Files         124      124           
  Lines        5305     5305           
  Branches     1137     1137           
=======================================
  Hits         2705     2705           
  Misses       2311     2311           
  Partials      289      289           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@KevinEyo1 KevinEyo1 marked this pull request as ready for review March 17, 2024 13:48
@yucheng11122017 yucheng11122017 marked this pull request as draft March 18, 2024 07:17
@kaixin-hc
Copy link
Contributor

It still seems to be on "on PR closed" - any reason why you aren't using "on PR approved" as suggested in the issue by @tlylt ?

@KevinEyo1
Copy link
Contributor Author

KevinEyo1 commented Mar 25, 2024

Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

Great - thanks for working on this! (BTW I think your links are linking to the successful job rather than the PRS this is generated, which rlly confused me at first haha)

I think this is ready to merge - @yucheng11122017 want to take another look?

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the work :) Would be very useful

@yucheng11122017
Copy link
Contributor

@KevinEyo1 could you check why the check is failing on this PR?

image

@KevinEyo1
Copy link
Contributor Author

KevinEyo1 commented Mar 26, 2024

Hi @yucheng11122017, I will take a look into it

@yucheng11122017
Copy link
Contributor

Hi @yucheng11122017, I will take a look into it

This PR

@KevinEyo1
Copy link
Contributor Author

Hi @yucheng11122017, can you try it now? I gave the action permission to write to PRs which allows it to add labels.

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM

@yucheng11122017
Copy link
Contributor

I think it still doesn't work @KevinEyo1
Ill leave the approval here first so you can check the logs more easily
https://github.com/MarkBind/markbind/actions/runs/8431248927/job/23088357523?pr=2470

@KevinEyo1
Copy link
Contributor Author

KevinEyo1 commented Mar 26, 2024

Hi @yucheng11122017 sorry about that, can you try again? I set pr - write instead of issue - write for better scoping (pr is a subset of issue), but the action im using interacts with the github API through issues. I changed it back to issue - write so it should work now

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

For testing

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

test

@KevinEyo1
Copy link
Contributor Author

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

(Actual approval) Thank you for all the changes @KevinEyo1 and the investigation! LGTM :)

@kaixin-hc kaixin-hc merged commit e95e588 into MarkBind:master Mar 29, 2024
9 checks passed
@github-actions github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Patch Version resolver: increment by 0.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Utilize GitHub Actions to check for SEMVER impact label
3 participants