Cookbook #8
Cookbook #8
Conversation
Add a site built with hugo (https://gohugo.io/). Use the https://themes.gohugo.io/themes/hugo-theme-nightfall/ theme. Add the cookbook skeleton recently merged into https://github.com/rust-bitcoin/rust-bitcoin.github.io
Add a bash script to build and deploy the site.
When we commit the `public` directory changes currently we use `date` which puts the date in local format. Since we are a global team use UTC instead.
So that devs don't accidentally deploy change the `build.sh` script to check that we are on the master branch before building and deploying the site to github pages.
The website is deployed at its proper address so inform about it. Also mention the cookbook being incomplete.
In preparation for the 0.30 release write up a upgrade guide as a blog post to help users with the upcoming release. Please note, includes comments on as-yet-unmerged PRs (*cough* hex).
I put the wrong date prior to merging the 0.30.0 release blogpost, should have been March not February.
Now version 0.30.0 is out add a link to docsrs for it.
Signed-off-by: Harshil Jani <[email protected]>
.github/dependabot.yml
Outdated
| - package-ecosystem: "cargo" | ||
| directory: "cookbook/tests/" | ||
| schedule: | ||
| # Check for updates to Rust dependencies every week | ||
| interval: "weekly" |
There was a problem hiding this comment.
NOTE to myself: I need to test this (first time using the package-ecosystem: "cargo").
.github/workflows/gh-pages.yml
Outdated
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup mdBook | ||
| uses: peaceiris/actions-mdbook@v1 | ||
| with: | ||
| mdbook-version: 'latest' | ||
|
|
||
| - run: mdbook build | ||
|
|
||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./cookbook/book |
There was a problem hiding this comment.
@tcharding this is totally wrong, I am adding as a placeholder now.
I'll update once I finish to add the content.
Feel free to comment, edit, contribute...
.github/workflows/test.yml
Outdated
| push: | ||
| branches: [ master, '0.[0-9]+' ] | ||
| pull_request: | ||
| branches: [ master, '0.[0-9]+' ] |
There was a problem hiding this comment.
NOTE: we might use v0.[0-9]+
cookbook/book.toml
Outdated
| @@ -1,6 +1,10 @@ | |||
| [book] | |||
| authors = ["Harshil Jani"] | |||
| authors = ["Toby Harding<[email protected]>", "Einherjar <[email protected]>"] | |||
There was a problem hiding this comment.
@tcharding I have no idea what to put in here...
There was a problem hiding this comment.
Leave Harshil's name in there please because he did some prior work. Definitely throw your name in there since you are working on it. Leave mine out for now please because I have not added anything meaningful, I'll add it later if/when I do. (I'm Tobin BTW :)
There was a problem hiding this comment.
Sorry I thought Harshil was a placeholder 😓
|
I screwup the rebase. Let me try again :/ |
rust-bitcoinnew versions dependabot will open a PR here to updateDetails
I want this cookbook to be tested automatically on CI, so the code will always run.
The only solution that worked for me was this workaround that is used in The Rust Rand Book.