diff --git a/.github/workflows/guide-ci.yml b/.github/workflows/guide-ci.yml new file mode 100644 index 0000000000..761ba15864 --- /dev/null +++ b/.github/workflows/guide-ci.yml @@ -0,0 +1,29 @@ +name: User Guide CI +on: + push: + paths: + - guide/** + +jobs: + test: + name: Test + runs-on: ubuntu-latest + permissions: + contents: write # To push a branch + pull-requests: write # To create a PR from that branch + steps: + - uses: actions/checkout@master + - name: Install Rust + run: | + rustup set profile minimal + rustup toolchain install stable + rustup default stable + - name: Install latest mdbook + run: | + tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') + url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" + mkdir bin + curl -sSL $url | tar -xz --directory=bin + echo "$(pwd)/bin" >> $GITHUB_PATH + - name: Run tests + run: mdbook test guide \ No newline at end of file diff --git a/.github/workflows/guide.yml b/.github/workflows/guide.yml new file mode 100644 index 0000000000..02240bebf7 --- /dev/null +++ b/.github/workflows/guide.yml @@ -0,0 +1,39 @@ +name: Deploy +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write # To push a branch + pages: write # To push to a GitHub Pages site + id-token: write # To update the deployment status + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install latest mdbook + run: | + tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') + url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" + mkdir mdbook + curl -sSL $url | tar -xz --directory=./mdbook + echo `pwd`/mdbook >> $GITHUB_PATH + - name: Build Book + run: | + # This assumes your book is in the root of your repository. + # Just add a `cd` here if you need to change to another directory. + mdbook build guide + - name: Setup Pages + uses: actions/configure-pages@v2 + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + # Upload entire repository + path: 'guide/book' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file diff --git a/guide/.gitignore b/guide/.gitignore new file mode 100644 index 0000000000..3006b271da --- /dev/null +++ b/guide/.gitignore @@ -0,0 +1 @@ +book/ diff --git a/guide/book.toml b/guide/book.toml new file mode 100644 index 0000000000..6de59f590e --- /dev/null +++ b/guide/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["The Creusot Contributors"] +language = "en" +multilingual = false +src = "src" +title = "Creusot User Guide" diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md new file mode 100644 index 0000000000..df00cc81ad --- /dev/null +++ b/guide/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Quickstart](./quickstart.md) diff --git a/guide/src/quickstart.md b/guide/src/quickstart.md new file mode 100644 index 0000000000..acb98436ef --- /dev/null +++ b/guide/src/quickstart.md @@ -0,0 +1 @@ +# Quickstart