Merge pull request #6179 from stacks-network/release/3.1.0.0.12

Merge release/3.1.0.0.12 to master

Author: wileyj

.github/workflows/ci.yml

@@ -19,7 +19,6 @@ on:
       - opened
       - reopened
       - synchronize
-      - ready_for_review
 
 defaults:
   run:

.github/workflows/core-build-tests.yml

@@ -4,11 +4,15 @@ name: Core build tests
 #   - PRs are (re)opened against develop branch
 on:
   workflow_call:
-
+    
 jobs:
   check-consts:
     name: Check the constants from stacks-inspect
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+
     steps:
       - name: Checkout the latest code
         id: git_checkout
@@ -21,13 +25,35 @@ jobs:
         uses: actions-rust-lang/setup-rust-toolchain@11df97af8e8102fd60b60a77dfbf58d40cd843b8 # v1.10.1
         with:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
-      - name: Build the binaries
-        id: build
+
+      ## run cargo check steps
+      - name: Cargo Check
+        id: cargo_check
+        run: |
+          cargo check
+
+      - name: Cargo Check (monitoring_prom)
+        id: cargo_check_prom
+        run: |
+          cargo check --features monitoring_prom
+
+      - name: Cargo Check (clarity)
+        id: cargo_check_clarity
         run: |
-          cargo build
+          cargo check -p clarity --no-default-features
+
+      - name: Cargo Check (stacks-common)
+        id: cargo_check_stacks-common
+        run: |
+          cargo check -p stacks-common --no-default-features
+
       - name: Dump constants JSON
         id: consts-dump
-        run: cargo run --bin stacks-inspect -- dump-consts | tee out.json
-      - name: Set expected constants JSON
+        run: |
+          cargo run --bin stacks-inspect -- dump-consts | tee out.json
+
+      ## output any diff to the github job summary
+      - name: Compare expected constants JSON
         id: expects-json
-        run: diff out.json ./sample/expected_consts.json
+        run: |
+          diff out.json ./sample/expected_consts.json >> $GITHUB_STEP_SUMMARY

.github/workflows/lock-threads.yml

@@ -29,7 +29,7 @@ jobs:
         id: lock_threads
         uses: stacks-network/actions/lock-threads@main
         with:
-          github-token: ${{ secrets.GH_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           issue-inactive-days: 7
           pr-inactive-days: 7
           discussion-inactive-days: 7

.github/workflows/workflow-cleanup.yml

@@ -12,15 +12,19 @@ on:
       workflow-ttl:
         description: "How many days to keep a successful workflow (default: 30)"
         required: false
-        default: "30"
+        default: "60"
       failed-workflow-ttl:
         description: "How many days to keep failed workflows (default: 15)"
         required: false
-        default: "15"
+        default: "60"
   schedule:
     ## Run every day at 00:00:00
     - cron: "0 0 * * *"
 
+permissions:
+  actions: write    # to delete workflow runs and caches
+  contents: read    # to access repo contents 
+
 ## env vars are transferred to composite action steps
 env:
   CACHE_TTL: 7 ## number of days to keep a cache
@@ -41,7 +45,7 @@ jobs:
         id: cleanup
         uses: stacks-network/actions/cleanup/workflows@main
         with:
-          token: ${{ secrets.GH_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           cache-ttl: ${{ inputs.cache-ttl || env.CACHE_TTL}}
           workflow-ttl: ${{ inputs.workflow-ttl || env.WORKFLOW_TTL}}
           failed-workflow-ttl: ${{ inputs.failed-workflow-ttl || env.FAILED_WORKFLOW_TTL }}

CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to the versioning scheme outlined in the [README.md](README.md).
 
+## [3.1.0.0.12]
+
+### Added
+
+- Document missing config structs
+- Document MinerConfig parameters
+- Document BurnchainConfig parameters
+- Document NodeConfig parameters
+
+### Changed
+
+- `get_fresh_random_neighbors` to include allowed neigbors
+- Logging improvements and cleanup
+- Move serde serializers to stacks_common
+- Depend on clarity backing store interface
+- Updated `./docs/event-dispacher.md`
+
+### Fixed
+
+- Handle Bitcoin reorgs during Stacks tenure extend
+
 ## [3.1.0.0.11]
 
 - Hotfix for p2p stack misbehavior in mempool syncing conditions