Merge #799: ci: pin nightly rust compiler version

6df8cad ci: add weekly cronjob to update nightly compiler pin (Andrew Poelstra)
0977f73 ci: pin rustc nightly version (Andrew Poelstra)
08de687 ci: update maintainer-tools version (Andrew Poelstra)

Pull request description:

  Turns out we were most of the way there already.

  I added `secrets.APOELSTRA_CREATE_PR_TOKEN` to this repo so the weekly cronjob should work. I just copy/pasted the code from rust-bitcoin.

ACKs for top commit:
  sanket1729:
    utACK 6df8cad

Tree-SHA512: 88dde6504287f4d708345b4721ea932ad6a99221bbd2b88a3871dde0368a3b6d42ec5cf36cc128c87d8bf2df836ae49091600eb8f63d8ca27bdea90df5f543bb

Author: apoelstra

.github/workflows/cron-weekly-update-nightly.yml

@@ -0,0 +1,41 @@
+name: Update Nightly rustc
+on:
+  schedule:
+    - cron: "5 0 * * 6" # Saturday at 00:05
+  workflow_dispatch: # allows manual triggering
+jobs:
+  format:
+    name: Update nightly rustc
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - name: Update rust.yml to use latest nightly
+        run: |
+          set -x
+          # Not every night has a nightly, so extract the date from whatever
+          # version of the compiler dtolnay/rust-toolchain gives us.
+          NIGHTLY_DATE=$(rustc +nightly --verbose --version | sed -ne 's/^commit-date: //p')
+          # Update the nightly version in the reference file.
+          echo "nightly-${NIGHTLY_DATE}" > nightly-version
+          echo "nightly_date=${NIGHTLY_DATE}" >> $GITHUB_ENV
+          # Some days there is no new nightly. In this case don't make an empty PR.
+          if ! git diff --exit-code > /dev/null; then
+              echo "Updated nightly. Opening PR."
+              echo "changes_made=true" >> $GITHUB_ENV
+          else
+              echo "Attempted to update nightly but the latest-nightly date did not change. Not opening any PR."
+              echo "changes_made=false" >> $GITHUB_ENV
+          fi
+      - name: Create Pull Request
+        if: env.changes_made == 'true'
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.APOELSTRA_CREATE_PR_TOKEN }}
+          author: Update Nightly Rustc Bot <[email protected]>
+          committer: Update Nightly Rustc Bot <[email protected]>
+          title: Automated daily update to rustc (to nightly-${{ env.nightly_date }})
+          body: |
+           Automated update to Github CI workflow `rust.yml` by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
+          commit-message: Automated update to Github CI to rustc nightly-${{ env.nightly_date }}
+          branch: create-pull-request/daily-nightly-update

.github/workflows/rust.yml

@@ -9,6 +9,17 @@ on:   # yamllint disable-line rule:truthy
 name: Continuous integration
 
 jobs:
+  Prepare:
+    runs-on: ubuntu-24.04
+    outputs:
+      nightly_version: ${{ steps.read_toolchain.outputs.nightly_version }}
+    steps:
+      - name: "Checkout repo"
+        uses: actions/checkout@v4
+      - name: "Read nightly version"
+        id: read_toolchain
+        run: echo "nightly_version=$(cat nightly-version)" >> $GITHUB_OUTPUT
+
   Stable:                       # 2 jobs, one per lock file.
     name: Test - stable toolchain
     runs-on: ubuntu-latest
@@ -23,7 +34,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -34,6 +45,7 @@ jobs:
 
   Nightly:                      # 2 jobs, one per lock file.
     name: Test - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -46,10 +58,12 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Set dependencies"
         run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
       - name: "Run test script"
@@ -69,7 +83,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -82,6 +96,7 @@ jobs:
 
   Lint:
     name: Lint - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -94,10 +109,12 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Install clippy"
         run: rustup component add clippy
       - name: "Set dependencies"
@@ -119,7 +136,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -130,6 +147,7 @@ jobs:
 
   Docsrs:
     name: Docs - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -142,17 +160,20 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Set dependencies"
         run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
       - name: "Run test script"
         run: ./maintainer-tools/ci/run_task.sh docsrs
 
   Bench:
     name: Bench - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -165,29 +186,34 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          rev: b2ac115
+          ref: c3324024ced9bb1eb854397686919c3ff7d97e1e
           path: maintainer-tools
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Set dependencies"
         run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
       - name: "Run test script"
         run: ./maintainer-tools/ci/run_task.sh bench
 
   Format:                       #  1 job, run cargo fmt directly.
     name: Format - nightly toolchain
+    needs: Prepare
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
     steps:
       - name: "Checkout repo"
         uses: actions/checkout@v4
       - name: "Select toolchain"
-        uses: dtolnay/rust-toolchain@nightly
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.Prepare.outputs.nightly_version }}
       - name: "Install rustfmt"
         run: rustup component add rustfmt
       - name: "Check formatting"
-        run: cargo +nightly fmt --all -- --check
+        run: cargo fmt --all -- --check
 
   Integration:                  # 1 job for each bitcoind version we support.
     name: Integration tests - stable toolchain

nightly-version

@@ -0,0 +1 @@
+nightly-2025-03-21