Skip to content

Commit

Permalink
github/workflows: refactor comment workflow to not use github-script
Browse files Browse the repository at this point in the history
It is not actively maintained, third-party, javascript wrapper on GitHub
API. The v7 version has issues and most importantly, we don't need a
JavaScript interface to create a comment. Use the first-party CLI tool
and jq.

Sort artifacts by name while at it.
  • Loading branch information
kasper93 committed May 19, 2024
1 parent e6e0aaa commit 2ecd34a
Showing 1 changed file with 34 additions and 52 deletions.
86 changes: 34 additions & 52 deletions .github/workflows/comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,64 +2,46 @@ name: comment

on:
workflow_run:
workflows: ["build"]
workflows: [build]
types: [completed]

jobs:
pr_comment:
if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
if: github.event.workflow_run.event == 'pull_request' &&
github.event.workflow_run.conclusion == 'success'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v6
with:
script: |
const { owner, repo } = context.repo;
const run_id = ${{ github.event.workflow_run.id }};
const pull_head_sha = '${{github.event.workflow_run.head_sha}}';
- env:
GH_REPO: ${{ github.repository }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
pr=$(gh pr list --state open --json headRefOid,number \
--jq '.[] | select(.headRefOid == "${{ github.event.workflow_run.head_sha }}") | .number')
if [ -z "$pr" ]; then
echo "No matching pull request found"
exit 1
fi
const issue_number = await(async () => {
const pulls = await github.rest.pulls.list({ owner, repo });
for await (const { data } of github.paginate.iterator(pulls)) {
for (const pull of data) {
if (pull.head.sha === pull_head_sha) {
return pull.number;
}
}
}
})();
if (issue_number) {
core.info(`Using pull request ${issue_number}`);
} else {
return core.error(`No matching pull request found`);
}
artifacts=$(gh run view ${{ github.event.workflow_run.id }} --json artifacts --jq '.artifacts')
if [ -z "$artifacts" ]; then
echo "No artifacts found"
exit 1
fi
const { data: { artifacts } } = await github.rest.actions.listWorkflowRunArtifacts({ owner, repo, run_id });
if (!artifacts.length) {
return core.error(`No artifacts found`);
}
body=$(echo "$artifacts" | jq -r '
def link: "https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}/actions/runs/${{ github.event.workflow_run.id }}/artifacts/\(.id)";
def entry: "* [\(.name)](link)";
"Download the artifacts for this pull request:\n\n<details><summary>Windows</summary>\n" +
(sort_by(.name) | map(select(.name | test("w64|msvc")) | entry) | join("\n")) +
"\n</details>\n\n<details><summary>macOS</summary>\n" +
(sort_by(.name) | map(select(.name | test("macos")) | entry) | join("\n")) +
"\n</details>"
')
let body = `Download the artifacts for this pull request:\n\n<details><summary>Windows</summary>\n`;
for (const art of artifacts) {
const art_link = `https://nightly.link/${owner}/${repo}/actions/artifacts/${art.id}.zip`;
if (art.name.includes('w64') || art.name.includes('msvc')) {
body += `\n* [${art.name}](${art_link})`;
}
}
body += `\n</details>\n\n<details><summary>macOS</summary>\n`;
for (const art of artifacts) {
const art_link = `https://nightly.link/${owner}/${repo}/actions/artifacts/${art.id}.zip`;
if (art.name.includes('macos')) {
body += `\n* [${art.name}](${art_link})`;
}
}
body += `\n</details>`;
const { data: comments } = await github.rest.issues.listComments({ repo, owner, issue_number });
const existing_comment = comments.find((c) => c.user.login === 'github-actions[bot]');
if (existing_comment) {
core.info(`Updating comment ${existing_comment.id}`);
await github.rest.issues.updateComment({ repo, owner, comment_id: existing_comment.id, body });
} else {
core.info(`Creating a comment`);
await github.rest.issues.createComment({ repo, owner, issue_number, body });
}
comment_id=$(gh issue comment list $pr --json id,author \
--jq '.[] | select(.author.login == "github-actions[bot]") | .id')
if [ -z "$comment_id" ]; then
gh pr comment $pr --body "$body"
else
gh issue comment update $comment_id --body "$body"
fi

0 comments on commit 2ecd34a

Please sign in to comment.