Skip to content

docs: Add deprecation note #147

docs: Add deprecation note

docs: Add deprecation note #147

Workflow file for this run

name: Book CI
on:
push:
paths:
- "book/"
- "book/**"
- ".github/workflows/book.yml"
- "**book**"
pull_request:
paths:
- "book/"
- "book/**"
- ".github/workflows/book.yml"
- "**book**"
workflow_dispatch:
paths:
- "book/"
- "book/**"
- ".github/workflows/book.yml"
- "**book**"
env:
MDBOOK_VERSION: "0.4.28"
jobs:
build:
name: Build
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout the repository
uses: actions/checkout@v6
- name: Install Python dependencies
run: |
pip3 install --user python-dateutil linkchecker
- name: Put pip binary directory into path
run: echo "~/.local/bin" >> $GITHUB_PATH
- name: Download mdBook ${{ env.MDBOOK_VERSION }}
run: |
mkdir -p /tmp/mdbook
curl -Lo- https://github.com/rust-lang/mdBook/releases/download/v${{ env.MDBOOK_VERSION }}/mdbook-v${{ env.MDBOOK_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -C /tmp/mdbook -xzv
- name: Build the contents of the book
run: "/tmp/mdbook/mdbook build book/ -d ../output/"
- name: Check links
run: linkchecker book
- name: Deploy
if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
uses: appleboy/[email protected]
with:
host: docs.espressif.com
username: ${{ secrets.PRODUCTION_USERNAME }}
key: ${{ secrets.PRODUCTION_KEY }}
target: ${{ secrets.PRODUCTION_TARGET }}
source: "output/"
strip_components: 1 # remove the prefix, it's already being placed in /projects/rust/no_std-training
overwrite: true