@kungfu-tech/buildchain 2.0.15 → 2.0.16

package/AGENTS.md

@@ -0,0 +1,71 @@
+# AGENTS.md
+
+This file orients coding agents and people working with Buildchain. It is a
+router, not a duplicate: it points to the authoritative documents rather than
+restating them.
+
+## Are you using Buildchain, or building it?
+
+- **Using Buildchain** - initialize a repository, call a reusable workflow, run
+  a release dry-run, or inspect the release model: start at the documentation
+  map, [`docs/MAP.md`](docs/MAP.md).
+- **Building or contributing to this repo** - read the rest of this file, then
+  [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+## Using this repo as a Buildchain consumer
+
+Stable consumers should pin actions and reusable workflows through the released
+Buildchain refs:
+
+```yaml
+uses: kungfu-systems/buildchain/actions/validate-config@v2
+uses: kungfu-systems/buildchain/actions/run-lifecycle@v2
+uses: kungfu-systems/buildchain/actions/promote-buildchain-ref@v2
+uses: kungfu-systems/buildchain/.github/workflows/.build.yml@v2
+```
+
+For new repositories, prefer the CLI:
+
+```sh
+npx @kungfu-tech/buildchain init --type package
+npx @kungfu-tech/buildchain validate --require-version-state
+npx @kungfu-tech/buildchain release --dry-run --target-ref alpha/v2/v2.0
+```
+
+See [`docs/cli.md`](docs/cli.md), [`docs/lifecycle-protocol.md`](docs/lifecycle-protocol.md),
+and [`docs/reusable-build-surface.md`](docs/reusable-build-surface.md) for the
+consumer contract.
+
+## Building this repo
+
+Buildchain is a pnpm workspace running on Node 24:
+
+```sh
+corepack enable pnpm
+pnpm install --frozen-lockfile
+pnpm run check
+```
+
+`pnpm run check` validates inventory data, lints root workflows, runs unit tests,
+and rebuilds every action bundle.
+
+## Proposing changes
+
+- Open pull requests against the relevant `dev/*` channel branch.
+- Write commit messages and PR descriptions in English, using lightweight
+  [Conventional Commits](https://www.conventionalcommits.org/)
+  (`type(scope): summary`).
+- Sign off every commit with the DCO: `git commit -s`.
+- Bugs, feature requests, questions, and documentation issues go through GitHub
+  issues; security vulnerabilities use private vulnerability reporting - see
+  [`SECURITY.md`](SECURITY.md).
+
+## Ground rules
+
+- Never include secrets, credentials, tokens, or private logs in code, commits,
+  issues, or pull requests.
+- Keep generated action bundles in sync with source changes.
+- Keep documentation in sync with behavior, especially release governance and
+  reusable workflow contracts.
+- [`docs/MAP.md`](docs/MAP.md) and [`CONTRIBUTING.md`](CONTRIBUTING.md) are the
+  sources of truth; when this summary and they disagree, follow them.

package/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing to Buildchain
+
+Thanks for your interest in Buildchain. This guide covers how to build the
+project, the repository conventions, and how changes are proposed and released.
+
+## Feedback, questions & security
+
+All project contact happens through GitHub - there is no email support channel.
+
+- **Bugs, feature requests, questions, documentation issues** - open a
+  [GitHub issue](https://github.com/kungfu-systems/buildchain/issues/new/choose).
+- **Code and documentation changes** - open a pull request.
+- **Security vulnerabilities** - report them privately, never in a public issue.
+  See [`SECURITY.md`](SECURITY.md).
+
+Please do not include secrets, credentials, tokens, private logs, or other
+sensitive material in issues or pull requests.
+
+## Prerequisites
+
+- Node.js 24
+- Corepack with pnpm 11
+- Go 1.25 for workflow validation paths that exercise Go setup
+
+Buildchain's reusable workflow consumers may build with npm, yarn, pnpm, CMake,
+Conan, Python, Docker, or other tools through lifecycle commands. This
+repository itself is a Node/pnpm workspace.
+
+## Repository layout
+
+- `.github/workflows` - repository checks, reusable workflows, and Buildchain
+  self-promotion.
+- `actions` - the active GitHub Actions surface:
+  `validate-config`, `run-lifecycle`, and `promote-buildchain-ref`.
+- `bin` - the published `buildchain` command-line entrypoint.
+- `docs` - release governance, lifecycle, reusable workflow, web-surface, and
+  CLI documentation.
+- `fixtures` - safe shape fixtures used by tests and reusable workflow checks.
+- `packages/core` - shared ESM library code used by CLI and scripts.
+- `scripts` - local and workflow runtime scripts.
+- `tests` - Node test runner suites and inventory contracts.
+
+Standalone historical `action-*` repositories are not mirrored here as active
+actions. See [`docs/migration-inventory.md`](docs/migration-inventory.md).
+
+## Build and verification
+
+```sh
+corepack enable pnpm
+pnpm install --frozen-lockfile
+pnpm run check
+```
+
+`pnpm run check` performs the repository done-check:
+
+- validates inventory data;
+- lints all root workflows, including hidden reusable workflows;
+- runs unit tests with `node --test`;
+- rebuilds action bundles through each action package.
+
+For narrower checks during development:
+
+```sh
+pnpm run test:unit
+pnpm run check:workflows
+pnpm run build
+npm pack --dry-run --json --registry=https://registry.npmjs.org/
+```
+
+## Generated files
+
+GitHub Actions consume committed bundles. When changing an action
+implementation, run the action build and commit the updated `dist/index.js`
+alongside the source files.
+
+## Commit messages
+
+- Write commit messages and pull request descriptions in **English**.
+- Follow lightweight [Conventional Commits](https://www.conventionalcommits.org/)
+  (`type(scope): summary`), for example `fix(publish): resume finalizing refs`.
+- Sign every commit with the Developer Certificate of Origin:
+
+```sh
+git commit -s -m "docs: add public repository onboarding"
+```
+
+The sign-off adds a line like:
+
+```text
+Signed-off-by: Your Name <you@example.com>
+```
+
+Pull requests are checked automatically; every commit must include this line.
+
+## Branches, pull requests & releases
+
+Development happens on channel branches per version line, promoted by pull
+request:
+
+```text
+dev/vX/vX.Y -> alpha/vX/vX.Y -> release/vX/vX.Y
+release/vX/vX.Y -> publish-gate/major
+```
+
+- Open normal changes against the relevant `dev/*` branch.
+- Merging into `alpha/*`, `release/*`, or `publish-gate/major` expresses a
+  release intent. Buildchain promotion then creates version-state commits,
+  exact tags, floating tags, npm publish evidence, and next-alpha state.
+- Manual promotion dispatch is dry-run only; non-dry-run promotion follows a
+  successful protected workflow path.
+
+See [`docs/release-governance.md`](docs/release-governance.md) and
+[`docs/release-flow.md`](docs/release-flow.md).
+
+## License
+
+By contributing you agree that your contributions are licensed under the
+project's [Apache License 2.0](LICENSE). Buildchain uses the Developer
+Certificate of Origin (DCO) and does not require a Contributor License Agreement
+(CLA).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-POLICY.md

@@ -0,0 +1,52 @@
+# License Policy
+
+Buildchain is released under the [Apache License 2.0](LICENSE).
+
+This page explains how that license is applied across the public repository and
+how contributions are accepted.
+
+## Project license
+
+Unless a file says otherwise, source code, examples, documentation, build
+scripts, tests, workflow files, and repository metadata in this repository are
+licensed under Apache-2.0.
+
+Package manifests in this repository should use:
+
+```json
+"license": "Apache-2.0"
+```
+
+## Contributions
+
+Buildchain uses the Developer Certificate of Origin (DCO), not a Contributor
+License Agreement (CLA).
+
+By contributing, you certify that you have the right to submit the contribution
+under Apache-2.0 and that it may be distributed as part of Buildchain under that
+license. Each commit in a pull request must include a DCO sign-off line:
+
+```text
+Signed-off-by: Your Name <you@example.com>
+```
+
+Use `git commit -s` to add this automatically.
+
+## Trademarks and brand names
+
+Apache-2.0 grants copyright and patent permissions. It does not grant trademark
+rights. Names, logos, domain names, and product marks such as "Kungfu" and
+"Buildchain" may be governed by separate brand guidelines.
+
+## Hosted and commercial services
+
+The open source license covers this repository. Hosted services, team features,
+enterprise support, managed deployments, commercial connectors, or other
+services offered by the project maintainers may use separate terms.
+
+## Third-party software
+
+Buildchain depends on third-party software. Source dependencies are declared in
+the repository manifests and lockfiles. Binary or bundled release artifacts must
+include the third-party notices and license information required by the
+components they redistribute.

package/README.md

@@ -191,8 +191,15 @@ This prints the branch/tag/version-state/governance plan that a channel merge
 would trigger. It is intentionally separate from `buildchain npm dry-run`, which
 only checks package publish shape.
 
-## Read Next
-
+## Documentation
+
+- [Documentation map](docs/MAP.md) routes common user, contributor, release,
+  workflow, and security questions to the right document.
+- [Contributing guide](CONTRIBUTING.md) explains local development, commit
+  rules, and pull request flow.
+- [Security policy](SECURITY.md) explains private vulnerability reporting.
+- [License policy](LICENSE-POLICY.md) explains Apache-2.0 and DCO contribution
+  terms.
 - [Release governance](docs/release-governance.md) explains the design problem,
   old ABV compatibility, hard constraints, and operational guarantees.
 - [Release flow diagrams](docs/release-flow.md) gives the branch/tag state
@@ -261,6 +268,7 @@ version lines or anchored release semantics.
 
 ## Read Next
 
+- [Documentation map](docs/MAP.md)
 - [Lifecycle protocol](docs/lifecycle-protocol.md)
 - [Publish transaction](docs/publish-transaction.md)
 - [Reusable build surface](docs/reusable-build-surface.md)

package/SECURITY.md

@@ -0,0 +1,43 @@
+# Security Policy
+
+## Reporting vulnerabilities
+
+Please report security issues privately instead of opening a public issue.
+
+Use GitHub's private vulnerability reporting: open the repository's **Security**
+tab and choose **Report a vulnerability**
+([open directly](https://github.com/kungfu-systems/buildchain/security/advisories/new)).
+The report stays private to the maintainers until a fix is coordinated.
+
+Do not report vulnerabilities through public issues, pull requests, or
+discussions.
+
+Include:
+
+- affected version, commit, action, workflow, package, or release artifact;
+- repository and workflow configuration needed to reproduce;
+- operating system, runner type, and architecture when relevant;
+- steps to reproduce;
+- expected impact;
+- whether the issue affects release governance, publish evidence, reusable
+  workflow behavior, CLI behavior, package publishing, or artifact provenance.
+
+## Scope
+
+Security reports may cover:
+
+- release ref, tag, or version-state integrity;
+- publish transaction evidence, recovery, or replay behavior;
+- trusted event gating for self-hosted runners or secrets;
+- publish-gate source locking and stale source detection;
+- GitHub Actions permission, token, or OIDC misuse;
+- package, artifact, npm, S3, OCI, or deployment-chain behavior;
+- local file access, path traversal, or unsafe archive handling;
+- credential, token, or private data exposure.
+
+## Public disclosure
+
+Please allow maintainers time to investigate and prepare a fix before public
+disclosure. The project will coordinate disclosure timing with reporters when a
+confirmed vulnerability affects released artifacts or reusable workflow
+consumers.