Merge Comment Reminders
ActionsTags
(1)Merge Comment Reminders finds flagged comments on edited files and comments them on your PR. This can be used when your code has specific rules about updates that you want to ensure are acknowledged.
First, add this code to .github/workflows/merge-comment-reminders.yml
name: Merge Comment Reminders
on:
pull_request:
types: [opened, edited, synchronize]
jobs:
merge-comment-reminders-action:
runs-on: ubuntu-latest
steps:
- name: Merge Comment Reminders
uses: pjflanagan/merge-reminders@v1.0.0Make sure you have enabled read and write action permissions in you Github repository settings. To do so, go to Actions > General > Workflow permissions and allow actions to "Read and write permissions"
Add comments beginning with MERGE: to your code like this:
// Header.tsx
const offsetHeight = 120; // MERGE: Be sure `offsetHeight` is reflected in `style.module.scss`Comments can use Markdown and Github usernames:
# api.py
# MERGE: Update the [documentation](https://docs.example.com) or @pjflanagan will be **very** upset
class API:
# ...Then, when a dev creat
EA4D
es a PR that modifies a file with MERGE: comments,
those instructions will automatically be commented on your PRs. Like this:
Merge Reminders
Header.tsx: Be sureoffsetHeightis reflected instyle.module.scssapi.pyUpdate the documentation or @pjflanagan will be very upset
You can then enforce all PR checkboxes are ticked before merging using Task Completed Checker.
Now you've configured your repo to require devs to acknowledge instructions for each file they updated. This is useful when:
- You want to ask devs to adhere to a pattern
- You need devs to update a different file to match changes in this one
- You need to remind devs to update documentation
- You need devs to be aware of how their code changes might cause unwanted side effects
Merge Reminders only supports # and // comments. If the language uses a different type of comment
you'll have to fake it.
<!--
HTML comment
# MERGE: be sure to update footer links to match the header links
-->- Clone the merge-reminders-test repo
- Point the
test-workflow-branch.ymlaction to the branch you'd like to test by changing/merge-reminders@mainto be@<your-branch-name> - Update files in the
examplesfolder
TKTK
TKTK
Merge Comment Reminders is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Tags
(1)Merge Comment Reminders is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.