ci: Add preview cookbook workflow #29
Conversation
storopoli
force-pushed
the
ci/preview-builds
branch
2 times, most recently
from
52c2047
to
8277d3c
Compare
|
It works, check the artifact in https://github.com/rust-bitcoin/rust-bitcoin.github.io/actions/runs/8949344061 (expires in 8 days from |
|
Are you able to put the zip contents inside an inner directory, so that when you unzip it, it doesn't dump files all over the current directory? Otherwise I think this is a pretty good idea! |
I never considered that, since both in my Macbook and Linux Desktop it unzips into a new directory and do not dump the files in the current dir: Are you unzipping in the terminal? |
Yes. I don't have any GUI zip utility that I'm aware of. |
|
Oh, neat, I can run But I still think that it's good hygeine to zip up files that already live in their own directory. |
Lol, I assumed he was winding you up :)
TIL, I always move to |
storopoli
force-pushed
the
ci/preview-builds
branch
from
8277d3c
to
3b29f5e
Compare
|
ping @tcharding |
|
I missed the force push two weeks ago. Feel free to ping me if something sits for even a few days, usually if I missed it for 3 days then I missed it totally - no benefit waiting any longer. |
|
Will wait for @apoelstra to ack because of the zip talk above, then I'll merge. |
|
3b29f5e has trailing whitespace in two places. Otherwise it's good -- I don't mind the zip thing since I learned the |
Add a new workflow file to enable previewing the cookbook. This workflow runs on pull requests and creates a preview of the cookbook using mdBook. The preview is then uploaded as an artifact and a comment is created in the pull request to notify users.
storopoli
force-pushed
the
ci/preview-builds
branch
from
3b29f5e
to
a755900
Compare
|
Rebased and removed the trailing whitespaces (also added 2 coins to the trailing whitespace jar)... |
|
One week has passed. Can we merge this? |
Add a new workflow file to enable previewing the cookbook.
The main advantage here is that in order to review new contributor,
the reviewer do not need to run the code locally to render the
mdbookoutput.This is useful since not only simplifies the review workflow,
but also diminishes the effort that it takes for someone to review
a contribution; hence opening opportunities for new reviewers to join in.
This workflow runs on pull requests and
creates a preview of the cookbook using mdBook.
The preview is then uploaded as an artifact.
It might be useful to preview a rendered version
of the cookbook.