Action to automatically create doc issues on PR merge

[ianjevans]

This PR creates a GitHub Action workflow that is run when PRs to master or release-* branches are merged. If the PR's message body has a release note item, and the release note message isn't "None", it will create a corresponding issue in cockroachdb/docs with the title of the PR and the release note message.

Currently the docs team runs a script to generate docs release note issues after generating the release notes file for a particular release. That is, issues are created in batches at each alpha/beta/release/patch release. If a release is delayed significantly, the docs team might not become aware of a doc impact issue for weeks.

Creating docs issues when the PR merges allows the docs team to become aware of and triage issues with doc impact in real time.

Release note: None

Related to: #59546

[cockroach-teamcity]

This change is 

[rafiss]

If the PR's message body has a release note item, and the release note message isn't "None"

I think it is a fairly common workflow for PR bodies to have no release note, but the commit messages to have them. I think it's because there is other tooling out there that pulls out release notes from the commit messages. Is it possible to inspect the commit message too?

[ianjevans]

If the PR's message body has a release note item, and the release note message isn't "None"

I think it is a fairly common workflow for PR bodies to have no release note, but the commit messages to have them. I think it's because there is other tooling out there that pulls out release notes from the commit messages. Is it possible to inspect the commit message too?

Can you find an example of a PR with the release note item in the commit message? I should be able to add a step that searches the github context for comment messages, but it'd be easier if I could look at a real one to figure out where in the event context I should be looking.

[otan]

passing comment: is [closed] also when someone closes a PR but does not merge it?

[ianjevans]

The action will trigger in that scenario, yes, but the job has a check to see if the PR was merged on L17.

    if:              ${{ github.event.pull_request.merged == true }}

GitHub Actions doesn't have a PR merge event, only a close event.

So the end result is that if a PR is closed without merging, the Action will trigger but immediately end on the job check.

[otan]

Nice!

[rafiss]

@ianjevans here's an example where the PR doesn't have release notes (in this case the commits have Release note: None) #61713

[jseldess]

@ianjevans, this script looks in commit messages for Release note texts, I believe, in case it's helpful: https://github.com/cockroachdb/cockroach/blob/master/scripts/release-notes.py

[yzdocs]

Since the approach is substantially different, I have opened another PR for continuation of work here started by @ianjevans. The new PR: #65006

[cockroach-teamcity]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

ianjevans seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[jlinder]

@ianjevans, I'm going to close this PR given the goal of the PR is now accomplished by the Create Docs Issue nightly which creates issues in Jira for any new commits each day.