Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved support for commenting when course timings change. #1797

Merged
merged 2 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions .github/workflows/course-schedule-comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Based on https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
#
# This runs with the full repo permissions, but checks out the upstream branch, not the PR.
# Do not run arbitrary code from the PR here!
name: Comment PR with Course Schedule
on:
workflow_run:
workflows: ["Generate Course Schedule"]
types: [completed]

jobs:
upload:
runs-on: ubuntu-latest
if: >
github.event.workflow_run.event == 'pull_request' &&
github.event.workflow_run.conclusion == 'success'
steps:
- name: "Checkout"
uses: actions/checkout@v4

- name: "Setup Rust cache"
uses: ./.github/workflows/setup-rust-cache

- name: "Generate Schedule on upstream branch"
run: |
cargo run -p mdbook-course --bin course-schedule > upstream-schedule

- name: "Download artifact from PR workflow"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I think this can be simplified by using download-artifact action. When I was implementing my workflow, I wasn't aware of this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a try! The linked article seemed to say that wouldn't work, but on a closer reading maybe that's not true. Also, it's quite an old article so maybe it works now :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tried it, so it might indeed be not working :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, it requires a PAT with read access to the source repository, and won't accept the repository input parameter without one -- even if that repository might be public.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am ok with not implementing it as well if it is not easy.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(It's possible that the script I've used also won't work with a different, even public, repository -- we'll see!)

# actions/download-artifact@v4 cannot do this without being given a PAT, although that
# is not required for public forked repositories.
uses: actions/github-script@v7.0.1
with:
script: |
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
owner: context.repo.owner,
repo: context.repo.repo,
run_id: ${{github.event.workflow_run.id }},
});
var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
return artifact.name == "course-schedule"
})[0];
var download = await github.rest.actions.downloadArtifact({
owner: context.repo.owner,
repo: context.repo.repo,
artifact_id: matchArtifact.id,
archive_format: 'zip',
});
var fs = require('fs');
fs.writeFileSync('${{github.workspace}}/course-schedule.zip', Buffer.from(download.data));

- name: "Unzip artifact"
run: unzip course-schedule.zip

- name: "Comment on PR if schedules differ"
uses: actions/github-script@v7.0.1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
var fs = require('fs');
var pr_number = Number(fs.readFileSync('pr-number'));
var upstream = fs.readFileSync('upstream-schedule').toString();
var schedule = fs.readFileSync('schedule').toString();
if (upstream != schedule) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: pr_number,
body: schedule,
});
}
35 changes: 35 additions & 0 deletions .github/workflows/course-schedule.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Based on https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
name: Generate Course Schedule

on:
pull_request:
paths:
- "src/**.md"

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Rust cache
uses: ./.github/workflows/setup-rust-cache

- name: Generate Schedule
run: |
mkdir -p ./course-schedule
cargo run -p mdbook-course --bin course-schedule > course-schedule/schedule

# GitHub does not provide a reliable way to determine the PR number from which
# a workflow_run was triggered (https://github.com/orgs/community/discussions/25220),
# so we'll do the slightly awkward thing and put that in the artifact. This means
# schedules could potentially be spammed to any PR in the repository, but that is
# not an awful outcome (and clear, reportable evidence of abuse).
echo ${{ github.event.number }} > ./course-schedule/pr-number

- uses: actions/upload-artifact@v4
with:
name: course-schedule
path: course-schedule/