Skip to content

Commit

Permalink
Add artifacts upload for website
Browse files Browse the repository at this point in the history
  • Loading branch information
PicoCentauri committed Feb 15, 2024
1 parent ec5a0ed commit 936ee0c
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/workflows/comment-docs-download.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Comment on pull request
on:
workflow_run:
workflows: ['Documentation']
types: [completed]

jobs:
pr_comment:
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: |
async function insertUpdateComment(owner, repo, issue_number, purpose, body) {
const {data: comments} = await github.rest.issues.listComments(
{owner, repo, issue_number}
);
const marker = `<!-- bot: ${purpose} -->`;
body = marker + "\n" + body;
const existing = comments.filter((c) => c.body.includes(marker));
if (existing.length > 0) {
const last = existing[existing.length - 1];
core.info(`Updating comment ${last.id}`);
await github.rest.issues.updateComment({
owner, repo,
body,
comment_id: last.id,
});
} else {
core.info(`Creating a comment in issue / PR #${issue_number}`);
await github.rest.issues.createComment({issue_number, body, owner, repo});
}
}
const {owner, repo} = context.repo;
const run_id = ${{github.event.workflow_run.id}};
const pull_requests = ${{ toJSON(github.event.workflow_run.pull_requests) }};
if (!pull_requests.length) {
return core.error("This workflow doesn't match any pull requests!");
}
const artifacts = await github.paginate(
github.rest.actions.listWorkflowRunArtifacts, {owner, repo, run_id}
);
if (!artifacts.length) {
return core.error(`No artifacts found`);
}
if (artifacts.length !== 1) {
return core.error(`more than one artifact found`);
}
const link = `https://nightly.link/${owner}/${repo}/actions/artifacts/${artifacts[0].id}.zip`
let body = `Here is the build version of the cookbook in this pull request: [documentation.zip](${link}), `;
body += 'you can view it locally by unzipping `documentation.zip` and open the `index.html` with your favorite browser.';
core.info("Review thread message body:", body);
for (const pr of pull_requests) {
await insertUpdateComment(owner, repo, pr.number, "link-to-wheels", body);
}
7 changes: 7 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ jobs:
- name: build documentation
run: tox -e docs

- name: store documentation as github artifacts
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/build/html/*
overwrite: true # only keep the latest version of the documentation

- name: put documentation in the website
run: |
git clone https://github.com/$GITHUB_REPOSITORY --branch gh-pages gh-pages
Expand Down

0 comments on commit 936ee0c

Please sign in to comment.