search

octue / generate-pull-request-description

A GitHub action that updates PR descriptions from Conventional Commits
9 stars 7 forks source link

Add example of providing the skip indicator in a workflow to readme #5

Open cortadocodes opened 1 year ago

cortadocodes commented 1 year ago 
# This workflow updates the pull request description with an auto-generated section containing the categorised commit
# message headers of the commits since the last pull request merged into main. The auto generated section is enveloped
# between two comments: "<!--- START AUTOGENERATED NOTES --->" and "<!--- END AUTOGENERATED NOTES --->". Anything
# outside these in the description is left untouched. Auto-generated updates are skipped if
# "<!--- SKIP AUTOGENERATED NOTES --->" is added to the pull request description.