From 65ecc259070ab4a71e27e2abb61bd1d82e0c011e Mon Sep 17 00:00:00 2001
From: Kaur Kuut <strom@nevermore.ee>
Date: Wed, 11 Dec 2024 13:15:29 +0200
Subject: [PATCH] Replace CI `RUST_MIN_VER_PKGS` with `--workspace
 --ignore-private`. (#782)

The CI `RUST_MIN_VER_PKGS` configuration variable was meant to track
packages that are intended for publishing in order to limit MSRV checks
to only those packages. This same goal can be achieved universally
without the need for a configuration variable via the `--ignore-private`
`cargo-hack` option.

The immediate effect on this repo is that `xilem_core` is no longer part
of the MSRV check because it has `publish = false`. That is fine,
because the MSRV check will run just before publishing, triggered by the
PR that will remove `publish = false`, ensuring that the MSRV is
accurate before publishing.
---
 .github/workflows/ci.yml | 12 +++++-------
 tree_arena/Cargo.toml    | 16 +++++++---------
 2 files changed, 12 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index d1c396ee2..a25291cd3 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -9,9 +9,6 @@ env:
   # Be sure to also update the rust-version property in the workspace Cargo.toml file,
   # plus all the README.md files of the affected packages.
   RUST_MIN_VER: "1.81"
-  # List of packages that will be checked with the minimum supported Rust version.
-  # This should be limited to packages that are intended for publishing.
-  RUST_MIN_VER_PKGS: "-p xilem -p xilem_core -p masonry"
   # List of packages that can not target Wasm.
   NO_WASM_PKGS: "--exclude masonry --exclude xilem"
   # Only some of our examples support Android (primarily due to extra required boilerplate).
@@ -44,6 +41,7 @@ env:
 #
 # The MSRV jobs run only cargo check because different clippy versions can disagree on goals and
 # running tests introduces dev dependencies which may require a higher MSRV than the bare package.
+# Checking is limited to packages that are intended for publishing to keep MSRV as low as possible.
 #
 # If the workspace uses debug_assertions then we verify code twice, with it set to true or false.
 # We always keep it true for external dependencies so that we can reuse the cache for faster builds.
@@ -375,11 +373,11 @@ jobs:
           save-if: ${{ github.event_name != 'merge_group' }}
 
       - name: Run cargo check
-        run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} --locked --profile ci --optional-deps --each-feature
+        run: cargo hack check --workspace --ignore-private --locked --profile ci --optional-deps --each-feature
 
       - name: Run cargo check (no debug_assertions)
         if: env.USING_DEBUG_ASSERTIONS == 'true'
-        run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} --locked --profile ci --optional-deps --each-feature
+        run: cargo hack check --workspace --ignore-private --locked --profile ci --optional-deps --each-feature
         env:
           CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
 
@@ -407,11 +405,11 @@ jobs:
           save-if: ${{ github.event_name != 'merge_group' }}
 
       - name: Run cargo check
-        run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
+        run: cargo hack check --workspace --ignore-private ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
 
       - name: Run cargo check (no debug_assertions)
         if: env.USING_DEBUG_ASSERTIONS == 'true'
-        run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
+        run: cargo hack check --workspace --ignore-private ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
         env:
           CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
 
diff --git a/tree_arena/Cargo.toml b/tree_arena/Cargo.toml
index 3b879ddd8..9ec5db1b1 100644
--- a/tree_arena/Cargo.toml
+++ b/tree_arena/Cargo.toml
@@ -1,27 +1,22 @@
 [package]
 name = "tree_arena"
 version = "0.1.0"
-description = "An arena allocated tree designed for Linebender"
+description = "An arena allocated tree."
 keywords = ["arena", "tree"]
-categories = ["gui"]
+categories = ["algorithms", "data-structures"]
 edition.workspace = true
-rust-version.workspace = true
 license.workspace = true
 repository.workspace = true
 homepage.workspace = true
+rust-version.workspace = true
 
+publish = false # Remove just before publishing
 
 [package.metadata.docs.rs]
 all-features = true # all features are enabled - this means that the generated docs are for the safe version
 # There are no platform specific docs.
 default-target = "x86_64-unknown-linux-gnu"
 targets = []
-# rustdoc-scrape-examples tracking issue https://github.com/rust-lang/rust/issues/88791
-# cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"] # no examples yet
-
-
-[dependencies]
-hashbrown.workspace = true
 
 [features]
 # This crate contains two implementations of a tree for use in masonry, one safe and the other unsafe.
@@ -33,3 +28,6 @@ safe_tree = []
 
 [lints]
 workspace = true
+
+[dependencies]
+hashbrown.workspace = true