mirror of
https://github.com/pezkuwichain/revive.git
synced 2026-10-20 18:56:17 +00:00
LJandxermicus
55c4e32b82
## Description For more easily finding the details of the resolc binary releases for the various supported platforms, the plain JSON information will be displayed on [resolc-bin](https://github.com/paritytech/resolc-bin)'s [GitHub Pages website](https://paritytech.github.io/resolc-bin/). Changes: * Whenever there is a regular or nightly release: * The corresponding workflow files will run a script to update resolc-bin's `index.md` file (new file) with the updated JSON. * `index.md` will be the file GitHub Pages serves as HTML (by default it is built with Jekyll and the Markdown is processed by kramdown, hence the syntax seen in the script). * Documentation updates Thus, this will run on the next nightly release after this PR is merged. ## Resolved Issues Closes #443 --------- Co-authored-by: xermicus <cyrill@parity.io>
43 lines
951 B
YAML
43 lines
951 B
YAML
name: Check docs up-to-date
|
|
on:
|
|
push:
|
|
branches: ["main"]
|
|
paths:
|
|
- 'book/**'
|
|
- 'docs/**'
|
|
- '.gitignore'
|
|
- 'Makefile'
|
|
- '.github/workflows/book.yml'
|
|
pull_request:
|
|
branches: ["main"]
|
|
types: [opened, synchronize]
|
|
paths:
|
|
- 'book/**'
|
|
- 'docs/**'
|
|
- '.gitignore'
|
|
- 'Makefile'
|
|
- '.github/workflows/book.yml'
|
|
|
|
jobs:
|
|
check-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with: { fetch-depth: 0 }
|
|
|
|
- name: Install and test the mdBook
|
|
run: make test-book
|
|
|
|
- name: Build book
|
|
run: mdbook build book
|
|
|
|
- name: Build book to tmp
|
|
run: mdbook build book -d docs-tmp
|
|
|
|
- name: Compare with committed docs
|
|
run: |
|
|
if ! diff -r docs-tmp docs 2>/dev/null; then
|
|
echo "docs/ is not up-to-date. Run \`make book\` and commit the docs/ directory"
|
|
exit 1
|
|
fi
|