Skip to content

Commit 8cbd1e5

Browse files
docs(readme): add note in README about creating the "ld-flags" label first (#188)
This is a minor gotcha, but if you try to run the example Github action, it will break with "ld-flags does not exist" errors unless the Github label is created first. Co-authored-by: kallevmercury <164934876+kallevmercury@users.noreply.github.com>
1 parent 0827acf commit 8cbd1e5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ jobs:
6767
access-token: ${{ secrets.LD_ACCESS_TOKEN }}
6868
repo-token: ${{ secrets.GITHUB_TOKEN }}
6969

70-
# Add or remove labels on PRs if any flags have changed
70+
# Add or remove labels on PRs if any flags have changed.
71+
# Note: This example requires the "ld-flags" label to have been created in the repository first:
72+
# https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label
7173
- name: Add label
7274
if: steps.find-flags.outputs.any-changed == 'true'
7375
run: gh pr edit $PR_NUMBER --add-label ld-flags

0 commit comments

Comments
 (0)