ceedling 1.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f18f89f99b7e81f68293c994fa85ff25532ca62bd250c2d1c7e351ec3ec7a0
-  data.tar.gz: 1252cbea2a5752315c65826f8068313450cf08d0ea63259e1e8a5d422588140c
+  metadata.gz: 0610e698b34fe7dc61a65a1c455e28438cbe132bea10d85634b19fc791f5a293
+  data.tar.gz: 4f9b3d43150358c366de44a33697aa58460601fe372311524a303351b43eaba4
 SHA512:
-  metadata.gz: 7aeb58a943b8df79fa31e12694a16019fba66cf798cc899eccb4d1e7b64d0b5fe09e5965f376791381cbc8c0e47a65c0563dbc5a00e1523714e813b8491a9896
-  data.tar.gz: e6cf0643c68cd8fa2c96b99de3e2e95ca276b27bf5ecb5cfa41ae9f1371ed55f3675ec5491d585b989629f2f89b0f16fc65f0586daa6ade065fbe903d9208087
+  metadata.gz: acac7be5ef1b0b19eac71e189d178a39834405372ca4349cb529720bb3bc4a3fadfdbecf5e5fc462f5c72617052b3eddd0f334bf99a23a71fb576e7f247175fb
+  data.tar.gz: 9da4d2e23f1a6c45392177449d633332389093ca75804e22af4bb29d5feed971c5783296513cc4e6bf49492f337f45a154efa991829b3753aecb448959886084

data/.rspec

@@ -0,0 +1,3 @@
+-I spec/support
+-I spec/support/system
+-I spec/support/integration

data/.simplecov

@@ -0,0 +1,73 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Shared SimpleCov configuration. The unit-test suite picks this up through
+# SimpleCov's own upward-directory-search autoload (its CWD is this repo). The
+# system-test suite's own subprocess boot (spec/support/system/simplecov_boot.rb)
+# loads this file explicitly by absolute path instead, since that subprocess's CWD
+# is a throwaway deployed project directory, not this repo, when it starts -- the
+# autoload search would walk straight past it and find nothing.
+#
+# `.simplecov` is configuration only -- SimpleCov.configure, not SimpleCov.start.
+# Calling `.start` from this file is deprecated as of SimpleCov 1.x (tracking
+# would still begin for backward compatibility, but with a nagging warning on
+# every run). Each real entry point (spec/support/spec_helper.rb,
+# spec/support/system/simplecov_boot.rb, plugins/fff/spec/spec_helper.rb) loads
+# this config, then calls the bare `SimpleCov.start` that actually begins
+# tracking, once for its own process.
+#
+# cover (rather than only reporting files a run actually happened to require)
+# means a file no test ever touches still shows up at 0% instead of being silently
+# absent from the total -- lib/, bin/, and plugins/ are what the gem actually ships
+# and what both test suites exercise; vendor/ is CMock/Unity/CException's own
+# separately tested source, not this repo's. The /spec/ and /vendor/ filters below
+# also cover the handful of plugins with their own nested spec/vendor code (e.g.
+# plugins/fff/spec/, plugins/fff/vendor/fff/), not just this repo's own top-level
+# spec/ and vendor/.
+#
+# One cover call with a brace-glob covering all three trees.
+#
+# Grouped into the same three trees as a report's own tabs, so a report reads as
+# "how well is each shipped piece covered" rather than one flat file list.
+SimpleCov.configure do
+  cover '{lib,bin,plugins}/**/*.rb'
+
+  skip '/spec/'
+  skip '/vendor/'
+
+  # Root-of-lib/ files (lib/snapshot.rb, lib/ceedling.rb, lib/version.rb) are
+  # tiny require/entry-point shims, not business logic -- anchored so it
+  # doesn't also catch lib/ceedling/**, which is exactly what should still count.
+  # No leading "/": SimpleCov 1.x's project_filename is root-relative WITHOUT
+  # one (e.g. "lib/version.rb", not "/lib/version.rb", unlike 0.22) -- an
+  # anchor expecting a leading slash never matches anything, silently.
+  skip %r{\Alib/[^/]+\.rb\z}
+
+  # A plugin's config/defaults_<plugin>.rb is a table of constant tool definitions,
+  # loaded with that plugin's configuration and holding no logic to exercise. Anchored
+  # without a leading "/" for the same reason as above.
+  skip %r{\Aplugins/[^/]+/config/defaults_[^/]+\.rb\z}
+
+  # Thin adapters over Ruby stdlib/OS calls (file_wrapper.rb, system_wrapper.rb,
+  # yaml_wrapper.rb, bin/actions_wrapper.rb, etc.) -- existing tests stub around
+  # these rather than exercise them directly, so they read as permanently
+  # low/zero coverage noise rather than a real gap.
+  #
+  # A String argument here is path-segment-aware as of SimpleCov 1.x (must
+  # appear as a whole segment between "/" boundaries) -- deliberately a bare
+  # Regexp instead, since "_wrapper" is a fragment of a segment
+  # (file_wrapper.rb), not a whole one, and needs a true substring match.
+  skip(/_wrapper/)
+
+  # Anchored to the root of each tree -- a plain substring match (e.g. 'lib/')
+  # would also catch lib/ceedling/plugins/plugin_manager.rb (a real lib/
+  # subdirectory) into the plugins group, etc. No leading "/" in the anchor,
+  # same reasoning as the skip filter above -- project_filename never has one.
+  group 'bin', %r{\Abin/}
+  group 'lib', %r{\Alib/ceedling/}
+  group 'plugins', %r{\Aplugins/}
+end

data/GIT_COMMIT_SHA

@@ -1 +1 @@
-2209dc2
+13a540f

data/Gemfile

@@ -12,22 +12,98 @@ gem "bundler", "~> 2.5"
 # Testing tools
 gem "rspec", "~> 3.8"
 gem "rake", ">= 12", "< 14"
-gem "rr"
 gem "require_all"
 
-# `rexml` has been removed from the default gems in some Ruby versions -- needed
-# explicitly by the gcov Partials system-test cases, which parse gcovr's XML output.
-gem "rexml"
+# Test-only: spec/system/support/gcov_partials_test_cases.rb parses coverage XML.
+# rexml has been removed from the default gems bundled with some Ruby installations
+# (same category as benchmark below), so it must be declared explicitly here too.
+gem "rexml", ">= 3.2"
+
+# Dev-only: used by DependencyTracker's :full debug tier to render human-readable
+# content diffs. Soft dependency at runtime (lib/ceedling/dependencies/dependency_differ.rb
+# requires it defensively and degrades gracefully if absent) -- deliberately NOT declared in
+# ceedling.gemspec, so it is never a hard requirement for an installed release gem.
+gem "diff-lcs", "~> 1.5"
+
+# Dev-only: code coverage for CI's combined unit+system test coverage report.
+# require: false since it's only ever loaded when CEEDLING_TEST_COVERAGE is set --
+# deliberately NOT declared in ceedling.gemspec, same as diff-lcs above.
+#
+# The version gate exists to reach a significant SimpleCov feature revision.
+# SimpleCov 1.x requires Ruby >= 3.2 and gives access to modern config method names
+# (cover/skip/group) and the simplecov:disable/enable directive comments used
+# throughout .simplecov and bin/cli.rb. Benefiting from that modernization is only
+# possible by gating on Ruby version, hence the branch below.
+#
+# Coverage reporting is purely a CI mechanism, so it is deliberately confined to the
+# one leg that satisfies the version requirement: the `tests-linux` job on Ruby 3.3
+# (see ci.yml, where CEEDLING_TEST_COVERAGE is set only when matrix.ruby == '3.3').
+# No Windows or macOS leg, and no other Ruby leg, ever sets that variable, so none of
+# them load this gem at all. The ~> 0.22 fallback exists purely so `bundle install`
+# still resolves cleanly on older interpreters, not because anything in this repo
+# actually runs against it.
+if RUBY_VERSION >= '3.2'
+  gem "simplecov", "~> 1.1", require: false
+else
+  gem "simplecov", "~> 0.22", require: false
+end
+
+# Dev-only: sampling call-stack profiler for ad hoc performance investigation
+# (flame graphs of a real Ceedling build/test run). Not required by any
+# runtime code path -- deliberately NOT declared in ceedling.gemspec, same
+# as diff-lcs/simplecov above. install_if: keeps it out of ordinary `bundle
+# install` (CI included) entirely -- only `rake profile:setup` installs it,
+# by setting CEEDLING_PROFILING=true first. Gating is necessary, not just
+# tidy: its native C extension fails to build on Windows
+# (Gem::Ext::BuildError), which broke Windows CI outright when this gem was
+# briefly installed unconditionally. Whether stackprof can ever build on
+# Windows at all (even via an explicit `rake profile:setup` there) is
+# untested and unresolved -- profiling should currently be assumed
+# non-Windows-only.
+gem "stackprof", "~> 0.2", require: false, install_if: -> { ENV['CEEDLING_PROFILING'] == 'true' }
+
+# Dev-only: Ruby linting, limited to the Lint, Metrics, Security, and Performance
+# departments (see .rubocop.yml). Not required by any runtime code path --
+# deliberately NOT declared in ceedling.gemspec, same as diff-lcs/simplecov/stackprof
+# above. install_if: keeps these out of an ordinary `bundle install` so a developer
+# who never lints never pays to fetch them; `rake lint:setup` sets CEEDLING_LINT=true
+# and installs them on demand. Unlike CEEDLING_PROFILING, CI *does* set this variable
+# -- the lint job sets it at job scope because install_if: is Bundler's runtime
+# activation predicate as well as its install-time one, so `bundle exec` needs it too.
+#
+# Note install_if: governs installation and activation, not resolution: both gems and
+# their transitive dependencies appear in Gemfile.lock regardless, exactly as stackprof
+# already does. The savings are install time and bandwidth, not lockfile size.
+#
+# Both are pinned to a patch range rather than `~> 1.x`. Every RuboCop minor release
+# adds cops, which would silently change the offense set and move CI results with no
+# commit to point at. Bumping is therefore a deliberate act that lands alongside any
+# resulting .rubocop_todo.yml churn.
+gem "rubocop", "~> 1.91.0", require: false, install_if: -> { ENV['CEEDLING_LINT'] == 'true' }
+gem "rubocop-performance", "~> 1.27.0", require: false, install_if: -> { ENV['CEEDLING_LINT'] == 'true' }
+
+# Nothing here declares `erb`, and that is deliberate. Ceedling itself no longer uses
+# it at all. RSpec does: rspec-core requires `erb` at load time (configuration_options.rb)
+# without declaring a dependency on it, and that works only because `erb` is a default
+# gem, which is always requirable even under `bundle exec` and even when undeclared.
+# Verified a default gem on every Ruby Ceedling supports, through 3.5.
+#
+# If a future Ruby demotes `erb` to a bundled gem the way it did `benchmark` in 3.5,
+# `bundle exec rspec` will fail to load with `cannot load such file -- erb`. The fix is
+# a development/test-only declaration here, never a gemspec dependency, since no
+# Ceedling runtime code path requires it.
 
 # Ceedling dependencies
-gem "diy", "~> 1.1"
+#
+# `diy` is absent deliberately. Its source is vendored at vendor/diy, and
+# bin/ceedling puts that directory on the load path before requiring it, so the
+# vendored copy is what loads. Upstream has been unmaintained since 2009.
 gem "constructor", "~> 2"
 gem "thor", "~> 1.3"
 gem "deep_merge", "~> 1.2"
 
-# `erb` & `benchmark` have been removed from the default gems in some Ruby versions Ceedling supports.
-# These must be declared explicitly for plain `gem install` (non-Bundler) users to successfully span supported Ruby versions.
-gem "erb", ">= 2.2"
+# `benchmark` has been removed from the default gems in some Ruby versions Ceedling supports.
+# It must be declared explicitly for plain `gem install` (non-Bundler) users to successfully span supported Ruby versions.
 gem "benchmark", ">= 0.3"
 
 gem "unicode-display_width", "~> 3.1"

data/Gemfile.lock

@@ -1,18 +1,25 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    ast (2.4.3)
     benchmark (0.5.0)
     constructor (2.0.0)
     deep_merge (1.2.2)
     diff-lcs (1.6.2)
-    diy (1.1.2)
-      constructor (>= 1.0.0)
-    erb (2.2.0)
+    json (3.0.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
     parallel (1.28.0)
+    parser (3.3.12.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.2.1)
+    regexp_parser (2.13.1)
     require_all (3.0.0)
     rexml (3.4.4)
-    rr (3.1.2)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -26,6 +33,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
+    rubocop (1.91.0)
+      json (>= 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.27.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.89.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    simplecov (1.1.1)
+    stackprof (0.2.28)
     thor (1.5.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
@@ -44,14 +72,16 @@ DEPENDENCIES
   bundler (~> 2.5)
   constructor (~> 2)
   deep_merge (~> 1.2)
-  diy (~> 1.1)
-  erb (>= 2.2)
+  diff-lcs (~> 1.5)
   parallel (~> 1.26)
   rake (>= 12, < 14)
   require_all
-  rexml
-  rr
+  rexml (>= 3.2)
   rspec (~> 3.8)
+  rubocop (~> 1.91.0)
+  rubocop-performance (~> 1.27.0)
+  simplecov (~> 1.1)
+  stackprof (~> 0.2)
   thor (~> 1.3)
   unicode-display_width (~> 3.1)
 

data/README.md

@@ -1,41 +1,57 @@
-Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
+Ceedling [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/15117/badge)](https://www.bestpractices.dev/projects/15117) [![Docs](https://img.shields.io/badge/Docs-white?logo=materialformkdocs&link=https%3A%2F%2Fdocs.throwtheswitch.org%2FCeedling%2F)](https://docs.throwtheswitch.org/Ceedling/) [![Discourse](https://img.shields.io/badge/Discourse-purple?logo=discourse&link=https%3A%2F%2Fthrowtheswitch.discourse.group)](https://throwtheswitch.discourse.group) ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
 ========
 
-**Ceedling 1.1.9** is the latest and greatest.
+**Ceedling 1.2.0** is the latest and greatest.
 
-See [_Release Notes_][release-notes], [_Changelog_](docs/Changelog.md), 
-[_Breaking Changes_][breaking-changes], and [_Known Issues_][known-issues].
+See [_Changelog_](docs/Changelog.md). [_Release Notes_][release-notes], 
+[_Breaking Changes_][breaking-changes], and [_Known Issues_][known-issues] are
+not yet updated.
 
 See [🚀 Getting Started](#-getting-started) for installation and new 
 project set up.
 
-**New goodies in 1.1.x:**
+**New goodies in 1.2.0:**
+* **[Delta builds][delta-builds]** have been restored after a temporary hiatus following a major refactoring for 1.0.0. A [delta build][delta-build-overview] is simply a build run that only performs regeneration, compilation, or linking as needed because of changed files. [Delta builds][delta-builds] are automatic with no configuration and complement [parallel builds][parallel-builds] introduced in 1.0.0 for build time speedups.
+* **`#include` relative paths & duplicate filename disambiguation**. Ceedling now fully supports [relative paths in `#include` directives][same-named-files] and [`TEST_SOURCE_FILE()` build directive macros][test-source-file]. Ceedling is now also able to distinguish files of the same name using paths in the preceding and [at the command line][test-path-task] to distinguish test files of the same name (e.g. `ceedling test:foo/file` vs. `ceedling test:bar/file`).
+* **Multiple file extensions per file type.** You may now provide a list of file types via [`:extensions`][extension-config] to gather files into your project’s build. For instance, the extensions `.c` and `.cc` can now both be used together to collect all source file in your project.
+* **Shuffled test order.** Ceedling now supports [Unity’s][unity-framework] randomized test case ordering (via a [`:unity` configuration setting][shuffle-tests]). [Delta builds][delta-builds] automatically adjust to always rerun test executables so test case ordering is shuffled.
+* The [`TEST_SOURCE_FILE()` build directive macro][test-source-file-subtractive] can now be used to remove source files from a test executable build. This can be handy in overriding [Ceedling’s conventions][header-source-convention] for associating source files with a test executable if your project structure does not match up with [Ceedling’s conventions][header-source-convention].
+* The [build warnings], [JUnit report], [IDE integration], [GoogleTest report], [module generator], and [dependencies] plugins all received numerous bug fixes and feature expansions.
+* [Bullseye code coverage plugin][bullseye-plugin] re-enabled and modernized (disabled since 1.0.0).
+* **Dedicated mocks and test runner generation build tasks.** It is now possible to run the test build pipeline only up through generating mocks or test runners without running the rest of a build using `ceedling gen:mocks:<test>` and `ceedling gen:test_runner:<test>` mirroring the convention of `test:` tasks.
+* Ceedling prerelease and release builds now automatically [generate Software Bills of Material][sbom-docs] (SBOMs) and attach them to GitHub pre/releases along with the final Ruby gem.
+
+**Goodness introduced in 1.1.0:**
 * A [Partial][partials-docs] allows a test to mix mocked and real functions 
 from the same source module in a single test file and enables testing of 
 `static` and `inline` functions without modifying source code.
 * Ceedling is now complemented by a full, searchable [documentation site][ceedling-docs-site]
   available both online and as a local bundle exported from Ceedling’s 
   command line.
-* A new [Discourse community forum](https://throwtheswitch.discourse.group) to 
+* A new [Discourse community forum][forums] to 
   supersede the old, spammy Google Group and handful of disparate support channels.
-* More and expanded [example projects][example-projects].
-* New stock plugins for [Valgrind memory checking][valgrind-plugin] and 
-[Cppcheck static analysis][cppcheck-plugin].
-* The [GCov plugin][gcov-plugin]:
-   * Now supports coverage reports for all sources.
-   * Adds support for Modified Condition / Decision Coverage.
-* Mixins improvements including an option for [inline YAML at the command line][mixins-inline-yaml].
-* Ceedling’s test preprocessing is once again compatible with Unity’s 
-  parameterized test cases (support was temporarily removed with 1.0.0).
-* Incorporates the latest updates to [CMock] and [Unity].
 
+[delta-builds]: https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/
+[delta-build-overview]: https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/#delta-build-overview
+[parallel-builds]: https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/parallel-builds/
+[same-named-files]: https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#distinguishing-same-named-files
+[test-source-file]: https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/build-directives/#test_source_file
+[test-path-task]: https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/command-line/#ceedling-testpath
+[extension-config]: https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/extension/
+[unity-framework]: https://docs.throwtheswitch.org/Ceedling/1.2.0/overview/tools-and-frameworks/#unity
+[shuffle-tests]: https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/unity/#shuffle_tests
+[test-source-file-subtractive]: https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/build-directives/#test_source_file-subtractive-notation
+[header-source-convention]: https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/build-directives/#test_source_file-the-headersource-convention
+[build warnings]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/
+[JUnit report]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-log-factory/#junit-xml-format
+[IDE integration]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-ide-stdout/
+[GoogleTest report]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-gtestlike-stdout/
+[module generator]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/module-generator/
+[dependencies]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/
+[bullseye-plugin]: https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/bullseye/
+[sbom-docs]: https://docs.throwtheswitch.org/Ceedling/latest/project/sbom/
 [partials-docs]: https://throwtheswitch.github.io/Ceedling/1.1.0/testing-guide/partials/
-[example-projects]: https://throwtheswitch.github.io/Ceedling/latest/getting-started/example-projects/
 [ceedling-docs-site]: https://throwtheswitch.github.io/Ceedling/
-[valgrind-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/valgrind/
-[cppcheck-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/cppcheck/
-[gcov-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/gcov/
-[mixins-inline-yaml]: https://throwtheswitch.github.io/Ceedling/latest/configuration/mixins/?h=mixins#-mixin-command-line-flags
 
 # 🌱 Ceedling is a handy-dandy build system for C projects
 
@@ -129,7 +145,7 @@ library builds & dependency management, and more.
 [TDD]: http://en.wikipedia.org/wiki/Test-driven_development
 [test-doubles]: https://blog.pragmatists.com/test-doubles-fakes-mocks-and-stubs-1a7491dfa3da
 [FFF]: https://github.com/meekrosoft/fff
-[FFF-plugin]: https://throwtheswitch.github.io/Ceedling/latest/plugins/fff/
+[FFF-plugin]: https://docs.throwtheswitch.org/Ceedling/latest/plugins/fff/
 
 <br/>
 
@@ -160,6 +176,13 @@ Prereleases are ephemeral and will be pulled as development continues or bugs ar
 
 Prereleases are not officially supported, but feedback through submitting issues is very much welcome. As much help as is practical will be offered to support those exercising prereleases.
 
+## Software Bill of Materials
+Every release publishes a Software Bill of Materials in both CycloneDX and SPDX formats. Each document is attached to its release alongside the .gem file and is signed against it.
+
+The documents describe the Ceedling gem as distributed. They list what ships inside it — Unity, CMock, CException, and more — plus the Ruby dependencies a user installs. They do not describe the C code Ceedling builds for you, and they cannot describe the external tools an enabled plugin needs.
+
+See [Software Bill of Materials](https://docs.throwtheswitch.org/Ceedling/latest/project/sbom/) for what is included, how to verify a signature, and why a version-specific download link is the reliable one.
+
 <br/>
 
 # 🙋‍♀️ Need Help? Want to Help?
@@ -431,12 +454,12 @@ The [Agile Embedded Podcast][ae-podcast] includes an [episode on Ceedling][ceedl
 ## Ceedling docs
 
 * **_[Ceedling’s documentation site][ceedling-docs-site]_** contains everything you need to know to run Ceedling. It also references and links to the documentation of the projects, _Unity_ and _CMock_, that Ceedling weaves together into your test and release builds.
-* **[Release Notes][release-notes]**, **[Breaking Changes][breaking-changes]**, **[Known Issues][known-issues]**, and **[Changelog][changelog]** can be found in the **[docs/](docs/)** directory along with a number of guides (PDFs).
+* **[Release Notes][release-notes]**, **[Breaking Changes][breaking-changes]**, **[Known Issues][known-issues]**, and **[Changelog][changelog]** can be found in the **[docs/](docs/)** directory.
 * The **[Plugins section][ceedling-docs-plugins]** of Ceedling’s documentation lists all of Ceedling’s built-in plugins providing overviews and links to their documentation.
 
 _Note:_ Check the [Release Notes][release-notes] for a “cheat sheet” illustrating project configuration option changes for new releases in the form of a Ceedling project YAML configuration file. This may be especially useful to those already familiar with the tool wanting to update to the latest and greatest as quickly as possible.
 
-[ceedling-docs-plugins]: https://throwtheswitch.github.io/Ceedling/latest/plugins/
+[ceedling-docs-plugins]: https://docs.throwtheswitch.org/Ceedling/latest/plugins/
 
 ## Library and courses
 
@@ -466,16 +489,16 @@ Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling
 
 👀 See the **_[Quick Start][ceedling-docs-quick-start]_** section of Ceedling’s documentation site.
 
-[ceedling-docs-quick-start]: https://throwtheswitch.github.io/Ceedling/latest/getting-started/quick-start/
+[ceedling-docs-quick-start]: https://docs.throwtheswitch.org/Ceedling/latest/getting-started/quick-start/
 
 ## The basics
 
 ### Local installation from the RubyGems repository
 
-1. Install [Ruby]. (Only Ruby 3+ supported.)
+1. Install [Ruby]. (Ceedling requires Ruby 3+ but only unoficially supports Ruby 4.)
 1. Install the Ceedling gem from the RubyGems repository. All supporting frameworks are included and this style of installation installs dependencies as well.
    ```shell
-   > gem install ceedling
+   > gem install ceedling --no-document
    ```
 1. Begin crafting your project:
    1. Create an empty Ceedling project.
@@ -597,8 +620,8 @@ Or, use Ceedling’s built-in `examples` & `example` commands to extract a sampl
 
 See the [configuration section][ceedling-docs-config] of Ceedling’s documentation for way more details on your project configuration options than we can provide here.
 
-[example-config-file]: assets/project.yml
-[ceedling-docs-config]: https://throwtheswitch.github.io/Ceedling/latest/configuration/
+[example-config-file]: assets/features/project.yml
+[ceedling-docs-config]: https://docs.throwtheswitch.org/Ceedling/latest/configuration/
 
 ## Using Ceedling’s command line (and related)
 
@@ -739,4 +762,4 @@ the **[Ceedling development workflow][ceedling-dev-workflow]** guide.
 
 [coding-standard]: docs/ThrowTheSwitchCodingStandard.md
 [pr-checklist]: docs/CeedlingPullRequestChecklist.md
-[ceedling-dev-workflow]: https://throwtheswitch.github.io/Ceedling/latest/development/workflow/
+[ceedling-dev-workflow]: https://docs.throwtheswitch.org/Ceedling/latest/development/workflow/