Deploy Clippy book through CI/CD

.github/deploy.sh

@@ -3,7 +3,7 @@
 set -ex
 
 echo "Removing the current docs for master"
-rm -rf out/master/ || exit 0
+rm -rf out/master/ out/book/ || exit 0
 
 echo "Making the docs for master"
 mkdir out/master/
@@ -29,6 +29,9 @@ cp util/gh-pages/versions.html out/index.html
 echo "Making the versions.json file"
 python3 ./util/versions.py out
 
+# Copying the book
+mv book/book out
+
 # Now let's go have some fun with the cloned repo
 cd out
 git config user.name "GHA CI"

.github/workflows/deploy.yml

@@ -29,6 +29,12 @@ jobs:
         ref: ${{ env.TARGET_BRANCH }}
         path: 'out'
 
+    - name: Install mdbook
+      run: |
+        mkdir mdbook
+        curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.18/mdbook-v0.4.18-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+        echo `pwd`/mdbook >> $GITHUB_PATH
+
     # Run
     - name: Set tag name
       if: startswith(github.ref, 'refs/tags/')
@@ -57,6 +63,9 @@ jobs:
     - name: cargo collect-metadata
       run: cargo collect-metadata
 
+    - name: Build book
+      run: mdbook build book
+
     - name: Deploy
       run: |
         eval "$(ssh-agent -s)"

CONTRIBUTING.md

@@ -33,8 +33,7 @@ All contributors are expected to follow the [Rust Code of Conduct].
 If you're new to Clippy and don't know where to start the [Clippy book] includes
 a developer guide and is a good place to start your journey.
 
-<!-- FIXME: Link to the deployed book, once it is deployed through CI -->
-[Clippy book]: book/src
+[Clippy book]: https://rust-lang.github.io/rust-clippy/book/index.html
 
 ## High level approach
 

util/versions.py

@@ -31,7 +31,7 @@ def main():
 
     outdir = sys.argv[1]
     versions = [
-        dir for dir in os.listdir(outdir) if not dir.startswith(".") and os.path.isdir(os.path.join(outdir, dir))
+        dir for dir in os.listdir(outdir) if not dir.startswith(".") and dir != "book" and os.path.isdir(os.path.join(outdir, dir))
     ]
     versions.sort(key=key)