Updating pr596

Author: RenTrieu

.editorconfig

@@ -12,6 +12,6 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 
-[*.{json,md,nix,yml}]
+[*.{json,md,nix,toml,yml}]
 indent_style = space
 indent_size = 2

.envrc

@@ -1,2 +1,3 @@
-# If your shell has direnv support, it will automatically open a "nix-shell".
-use nix
+# If your shell has direnv support, it will automatically open a Nix shell with
+# all relevant dependencies to develop this project.
+use flake

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# If you are a frequent contributor to uefi-rs and would like to be featured in
+# the sponsors section, please contact the maintainers.
+github: phip1611

.github/codecov.yml

@@ -0,0 +1 @@
+comment: false

.github/dependabot.yml

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+    "schedule:weekly"
+  ],
+  "lockFileMaintenance": {
+    "enabled": true,
+    "automerge": true
+  },
+  "rangeStrategy": "update-lockfile",
+  "packageRules": [
+    {
+      "matchPackageNames": [
+        "crate-ci/typos"
+      ],
+      "automerge": true
+    }
+  ]
+}

.github/renovate.json

@@ -2,6 +2,7 @@ name: Book
 on:
   push:
     branches: [main]
+    tags: ['*']
 permissions:
   contents: write
 # Adapted from:
@@ -11,7 +12,7 @@ jobs:
     if: github.repository == 'rust-osdev/uefi-rs'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install mdbook
@@ -21,24 +22,32 @@ jobs:
           echo `pwd`/mdbook >> $GITHUB_PATH
       - name: Deploy GitHub Pages
         run: |
-          cd book
-          mdbook build
-          git worktree add gh-pages gh-pages
+          # Configure git user so that `git commit` works.
           git config user.name "Deploy from CI"
           git config user.email ""
-          cd gh-pages
+
+          # Get the highest `uefi` release tag.
+          highest_tag="$(git tag --list | grep uefi-v | sort -V | tail -1)"
+
+          # Create a worktree for the tag.
+          git worktree add wt-tag refs/tags/"${highest_tag}"
+
+          # Create a worktree for the `gh-pages` branch.
+          git worktree add wt-gh-pages gh-pages
+
           # Delete the ref to avoid keeping history.
-          git update-ref -d refs/heads/gh-pages
-          # Place the book under a "HEAD" directory so that we can later
-          # add other versions (e.g. "stable" or "v0.17") without breaking
-          # URLs.
-          rm -rf HEAD
-          mv ../book HEAD
-          git add HEAD
-          # Add an index in the root to redirect to HEAD. If we eventually
-          # serve multiple versions, this can be changed to a real index.
-          cp ../head_redirect.html index.html
-          git add index.html
+          git -C wt-gh-pages update-ref -d refs/heads/gh-pages
+
+          # Build the book for the tag. Don't use `--dest-dir` because it will
+          # delete the destination directory including the worktree checkout's
+          # ".git".
+          mdbook build wt-tag/book
+          # Copy output to the destination directory. Note the "/." is needed at
+          # the end of the source path so that hidden files are included.
+          cp -r wt-tag/book/book/. wt-gh-pages
+
           # Commit and push.
+          cd wt-gh-pages
+          git add .
           git commit -m "Deploy $GITHUB_SHA to gh-pages"
           git push --force

.github/workflows/book.yml

@@ -1,49 +1,47 @@
 name: Developer Productivity
 on:
+  merge_group:
   push:
   pull_request:
 jobs:
-  # Job to run change detection
+  # Job to run change detection for Nix-related files
   changes:
     runs-on: ubuntu-latest
     # Set job outputs to values from filter step.
     outputs:
       nix-src: ${{ steps.filter.outputs.nix-src }}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
-      - uses: dorny/paths-filter@v2
+        uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
         id: filter
         with:
           filters: |
             nix-src:
               - 'nix/**'
-              - 'shell.nix'
+              - 'flake.nix'
+              - 'flake.lock'
   # This is a convenience test to verify that the toolchain provided by
   # shell.nix is valid and can build + run the integration test.
   #
   # It only runs if the "nix-src" output of the "changes" job is true.
   nix_shell_toolchain:
-    name: "Nix toolchain: cargo xtask run works"
+    name: "Nix shell toolchain: `cargo xtask run` works"
     needs: changes
     if: ${{ needs.changes.outputs.nix-src == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - uses: Swatinem/rust-cache@v2
-      - uses: cachix/install-nix-action@v20
-        with:
-          # This channel is only required to invoke "nix-shell".
-          # Everything inside that nix-shell will use a pinned version of nixpkgs.
-          nix_path: nixpkgs=channel:nixos-23.05
+      - uses: cachix/install-nix-action@v31
       # Dedicated step to separate all the
       # "copying path '/nix/store/...' from 'https://cache.nixos.org'."
-      # messages from the actual build output. This job takes ~60secs.
+      # messages from the actual build output.
       - name: Prepare Nix Store
-        run: nix-shell --pure --run "cargo --version"
+        run: nix develop --command bash -c "cargo --version"
       - name: Run VM tests
         run: |
-          COMMAND="cargo +stable xtask run --target x86_64 --headless --ci --tpm=v1"
-          echo "Executing in nix shell now: $COMMAND"
-          nix-shell --pure --run "$COMMAND"
+          COMMAND="cargo xtask run --target x86_64 --headless --ci --tpm=v1"
+          echo "Executing in Nix shell: $COMMAND"
+          nix develop --command bash -c "$COMMAND"

.github/workflows/developer_productivity.yml

@@ -1,10 +1,42 @@
 name: QA
-on: [push, pull_request]
+on: [merge_group, push, pull_request]
 jobs:
   spellcheck:
     name: Spellcheck
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       # Executes "typos ."
-      - uses: crate-ci/[email protected]
+      - uses: crate-ci/[email protected]
+  lints:
+    name: Lints
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v31
+      - uses: Swatinem/rust-cache@v2
+      # Dedicated step to separate all the
+      # "copying path '/nix/store/...' from 'https://cache.nixos.org'."
+      # messages from the actual build output.
+      - name: Prepare Nix Store
+        run: nix develop --command echo
+      # A dedicated step removes spam from the actual job.
+      - name: Build cargo xtask
+        run: cargo xtask help >/dev/null
+      # Executing this in a Nix shell ensures that all our checks run as all
+      # required tooling exists.
+      - name: Check formatting
+        run: |
+          CMD="cargo xtask fmt --check"
+          nix develop --command bash -c "$CMD"
+      - name: Run clippy
+        run: |
+          rustup component add clippy
+          cargo xtask clippy --warnings-as-errors
+      - name: Run cargo doc (without unstable)
+        run: cargo xtask doc --warnings-as-errors --document-private-items
+      - name: Verify generated code is up-to-date
+        run: cargo xtask gen-code --check
+      - name: Run additional checks on the uefi-raw package
+        run: cargo xtask check-raw