Skip to content

Create support branch for CI scripts, documentation, and examples#288

Open
ryanofsky wants to merge 3 commits into
bitcoin-core:masterfrom
ryanofsky:pr/support
Open

Create support branch for CI scripts, documentation, and examples#288
ryanofsky wants to merge 3 commits into
bitcoin-core:masterfrom
ryanofsky:pr/support

Conversation

@ryanofsky
Copy link
Copy Markdown
Collaborator

@ryanofsky ryanofsky commented Jun 4, 2026

This PR creates a support branch that only holds libmultiprocess CI scripts, documentation, and example files so these files can be removed from the master branch in #287.

This PR is a complement to #287 and the overall idea of having a support branch should be discussed there, but the CI tweaks required for this change can be reviewed here.

Note: that for testing purposes a support branch currently exists in the repo pointing at these changes. But the branch can be reset and these changes can be more properly merged in after they are reviewed.

Also note CI jobs at the bottom of this PR are expected to fail because they depend on #287. The CI jobs in #287 show the combined effects of both PRs and should succeed if they are correct.

ryanofsky and others added 3 commits June 3, 2026 15:19
Files removed using:
  git ls-files ':!COPYING' ':!example/' ':!doc/' ':!ci/' ':!shell.nix' ':!.github/' | xargs git rm

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Restructures the repository so CI scripts, docs, and examples live on
the support branch while C++ source stays on master. CI uses GitHub
reusable workflows so both branches trigger full CI runs.

GitHub Actions changes:
- ci.yml, bitcoin-core-ci.yml: convert from standalone push/PR triggers
  to reusable workflows (on: workflow_call) accepting source_ref and
  support_ref inputs. Each job now checks out the C++ source at the
  default workspace path and the support branch at .support/. Script
  references updated from ci/scripts/ (and _libmultiprocess/ci/scripts/)
  to .support/ci/scripts/.
- ci-support-trigger.yml: new workflow that fires on push/PR to the
  support branch, calling the reusable workflows with source_ref fixed
  to refs/heads/master and support_ref set to the triggering commit.
  This lets support branch PRs be validated against master's C++ source.
- CI_CONFIG: repurposed from a config file path to a config name
  (e.g. "default", "llvm"). Scripts now resolve the path internally.

Script changes (ci/scripts/):
- run.sh: cd to support root before invoking nix so shell.nix and
  CMakeLists.txt are referenced without a path prefix.
- ci.sh, config.sh: resolve CI_CONFIG name to configs/$CI_CONFIG.bash
  relative to the script location rather than treating it as a full path.
- ci.sh: change default BUILD_TARGETS from (all tests mpexamples) to
  (all mptests mpexamples), since the tests target is only defined when
  master is the top-level cmake project (MP_STANDALONE=true).

New files:
- CMakeLists.txt: top-level cmake project for the support branch. Adds
  the master source tree as a subdirectory (via MP_SOURCE_DIR, defaulting
  to ..) and then adds example/ as a sibling subdirectory. Enables
  local builds via cmake -S .support -B .support/build-<name>.
- README.md: brief description of support branch contents and how to set
  up the .support worktree.

example/CMakeLists.txt: drop redundant include of TargetCapnpSources.cmake
(now included by the parent support CMakeLists.txt before add_subdirectory).
ci/README.md: update local run instructions to use CI_CONFIG name style
and new .support/ worktree paths.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bitcoin-core#287 is removing the mpcalculator,
mpprinter, and mpexample targets with causes an error in the Bitcoin
Core CI jobs without bitcoin/bitcoin#35454.

Switch the Bitcoin Core checkout in both jobs to use
refs/pull/35454/merge so CI tests against the compatible version. A
BITCOIN_CORE_REF env var is introduced at the top of the file; once
(and keep the var in place for any future API compatibility cycles).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@DrahtBot
Copy link
Copy Markdown

DrahtBot commented Jun 4, 2026

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.
A summary of reviews will appear here.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #290 (cmake: Skip PATH environment variable when discovering CapnProto by hebasto)
  • #289 (cmake: make target_capnp_sources use CURRENT dirs by ryanofsky)
  • #287 (Split repository into master (library source) and support (CI, docs, examples) branches. by ryanofsky)
  • #286 (proxy-client: fix TSan data race in clientDestroy by ryanofsky)
  • #285 (Add ReadList helper by ViniciusCestarii)
  • #283 (Add makePool method on ThreadMap by rustaceanrob)
  • #279 (doc: Add comments to FIELD_* constants in proxy.h by ViniciusCestarii)
  • #277 (Add std::unordered_set support and a helper BuildList to dedup list build handlers by ViniciusCestarii)
  • #276 (build: prepare for subtree split by Sjors)
  • #274 (Add nonunix platform support by ryanofsky)
  • #269 (proxy: add local connection limit to ListenConnections by enirox001)
  • #212 (ci: add newdeps job testing newer versions of cmake and capnproto by ryanofsky)
  • #209 (cmake: Increase cmake policy version by ryanofsky)
  • #204 (cmake: support default build and test workflow by purpleKarrot)
  • #175 (Set cmake_minimum_required(VERSION 3.22) by maflcko)
  • #163 (build: set cmake policy version to 3.31 by purpleKarrot)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants