Skip to content

docs: MIT license and a README an outside developer can start from [FACT-2004] - #6

Merged
practical-bot merged 2 commits into
mainfrom
chore/fact-2004-github-public-defaults
Nov 17, 2026
Merged

practical-bot merged 2 commits into
mainfrom
chore/fact-2004-github-public-defaults

Conversation

@jcotillo

@jcotillo jcotillo commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Why

Decision public-releases-follow-the-crm-defaults (2026-11-17): public releases follow crm and guardrails, with an MIT license and a README written for an outside developer, starting with a quick start. This repository is public and had no license.

What changed

  • LICENSE: MIT, copied verbatim from PracticalWorks/crm (Copyright (c) 2026 Practical Works).
  • README.md top: a one-line summary, ci and licence badges, what the repository holds (the reusable workflows and the org profile), and a quick start with one uses: call of test.yml@v1.3.0.
  • README.md bottom: a Used by section and a License section. Used by names only public repositories whose .github/workflows call PracticalWorks/.github/ (checked through gh api): crm, guardrails and rc-bridge. Private callers are deliberately not named, because this repository is public.
  • The runner example uses ["self-hosted","linux"] instead of an internal runner label.
  • Stale reference: the job.workflow_sha paragraph's example pin is now v1.3.0 (it said v1.2.0). No eko-ventures or other old org names were found. The tag table, the input tables, the Environment section and the pr-guard section are unchanged.
  • No workflow, action or script changed. Workflow behaviour is the same, so this needs no new tag; the next release picks it up.

Verification

node --test scripts/*.test.mjs (the README-tag test reads the tag table):

# tests 30
# pass 30
# fail 0

actionlint .github/workflows/*.yml exits 1 with the same 5 findings as before this change, all on the job context, which actionlint does not know yet. No workflow file is touched in this PR:

.github/workflows/coolify-deploy.yml:153:27: property "workflow_repository" is not defined in object type {...} [expression]
.github/workflows/coolify-deploy.yml:154:20: property "workflow_sha" is not defined in object type {...} [expression]
.github/workflows/pr-guard.yml:47:27: property "workflow_repository" is not defined in object type {...} [expression]
.github/workflows/pr-guard.yml:48:20: property "workflow_sha" is not defined in object type {...} [expression]
.github/workflows/pr-guard.yml:52:13: property "workflow_sha" is not defined in object type {...} [expression]

Refs: FACT-2004

🤖 Generated with Claude Code

…ACT-2004]

Follows the public-releases-follow-the-crm-defaults decision: LICENSE
copied from PracticalWorks/crm (MIT, Practical Works), a quick start at
the top of the README, and License and Used by sections at the bottom.
The job.workflow_sha example now names v1.3.0. No workflow changes, so
no tag bump.

Refs: FACT-2004

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jcotillo jcotillo added the merge:queued Hand this PR to the factory merge queue label Nov 17, 2026
…2004]

This repository is public. "Used by" linked PracticalWorks/frontdesk and
practical-works-acropolis/practical-works-factory, both private, and the
runner example used our internal `mini` label. "Used by" now names only
the public packages that call these workflows (crm, guardrails,
rc-bridge), and the example uses `["self-hosted","linux"]`.

Refs: FACT-2004

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@practical-bot practical-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The revised PR body is consistent with the diff and the current FACT-2004 scope. The root MIT license is byte-identical to PracticalWorks/crm's license (cmp_exit=0, 1072 bytes). The README now starts with the repository purpose and a quick start pinned to @v1.3.0, retains the tags, input, environment, and PR-guard material, and ends with verified public callers and a License section. The public-caller check found PracticalWorks/.github/ references in crm, guardrails, and rc-bridge; no stale eko-ventures reference or old @v1.2.0 example remains. No workflow files changed, and the changed-surface test command passed all 30 tests.

The PR's stated actionlint .github/workflows/*.yml claim was not reproducible in this review workspace because actionlint is not installed (sh: 1: actionlint: not found); this is an environment limitation, not a PR finding. The PR's CI check rows were both green on this exact head: guard-tests and guard / check (run 44156304932).

REVIEW VERDICT: approve
REVIEWED DIFF: base=main files=2 lines=51
FINDING: MIT license, README quick start and required retained sections, public Used by list, version/org cleanup, and unchanged workflow surface all meet FACT-2004 -> DROPPED (no defect)
UNVERIFIED: actionlint .github/workflows/*.yml could not run because actionlint is missing from this workspace; the PR's recorded five findings were not independently reproduced here.

@practical-bot
practical-bot merged commit 46996ba into main Nov 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge:queued Hand this PR to the factory merge queue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants