Document using @peter-evans' create-or-update-comment with this Action

solvaholic commented 3 years ago

Fixes #41

[x] Summarize findings from #41
[x] Demonstrate recommended configs in a public repo
[x] Document them such that they can be applied in others' workflows
[x] Either prove a safe way to trigger on pull requests from forks (see #67), or document they're not handled

solvaholic commented 3 years ago

Summarize findings from #41

Let the built-in add_pr_comment feature stay simple
Document the create-or-update-comment approach, including how to update the previous comment rather than create a new one (check out https://github.com/solvaholic/octodns-sync/issues/41#issuecomment-792209006)
Unrelated to this pull request, add plan output as an output (as suggested in #11 and https://github.com/solvaholic/octodns-sync/issues/41#issuecomment-780045572)

solvaholic commented 3 years ago

Using @xt0rted's example as a guide and @travislikestocode's edits for https://github.com/solvaholic/octodns-sync/pull/66, I stubbed out this reference config:

Which passed with empty payload and a fake --doit:

Demonstrate recommended configs in a public repo

Next, I think:

[x] Compare solvahol/dns's octodns-sync.yml again to @xt0rted's example, see what I missed
[x] Add pull_request trigger and add PR comment via create-or-update-comment
~Either prove a safe way to trigger on pull requests from forks (see #67), or document they're not handled~ Edit: Removed this to-do item to the main issue body.

solvaholic commented 3 years ago

solvaholic / octodns-sync