Repository navigation
almanac rulesets bos environment
The rules of every BOS workshop and project, for people and agents alike (the contributors committee). The first rule that applies decides.
Generated from
resources/almanac/rulesets/bos-environment.jsonwhen the docs are built; change the JSON, not this page. A case is judged against it bybos almanac judge "<case>"(see the almanac).
In order: the first rule that applies decides. With none, the verdict is
unknown: ask the owner.
Checks are never skipped: no --no-verify, no HUSKY=0. Chain a commit after the checks with &&.
-
when: action is
commit,pushormerge; flags is--no-verify,-norHUSKY=0 - source: AGENTS.md, rule 3
master is the spine of canon: nobody commits on it; it moves only through a pull request from releasing (or revision, in phase 2).
-
when: action is
commit; target ismasterormain - source: AGENTS.md, the craft loop
A mirror only checks: it never publishes, releases or deploys (Read the Docs, npm, images).
-
when: action is
publish,releaseordeploy; place ismirror* - source: the owner, phase 2: mirrors
The top-level areas of a workshop (.BOS, devarmory, forge, craftbook, archive) are never deleted, moved or restructured.
-
when: action is
delete,remove,move,restructureorrm; target is.BOS,devarmory,forge,craftbookorarchive - source: __WORKSHOP/AGENTS.md, rule 4
Secrets are never printed or shown: no cat .env, no tokens or keys in output, logs or commits.
-
when: action is
print,cat,show,echo,reveal,commitorlog; target is.env,*token*,secret*,*.pem,id_rsa*,id_ed25519*orpassword* - source: the owner, phase 2: security
Anything in the working tree an agent did not make is the owner's: it is intended, never reverted or overwritten.
-
when: action is
revert,overwrite,discardorreset; target isowner*orSarverott* - source: AGENTS.md, rule 2
Work for another repository is written down in forge/NOTES-for-repositories.md; the other repository is never edited.
-
when: role is
agent; action isedit,commit,changeorwrite; target isother*oranother* - source: AGENTS.md, where things go
Tests build their own temporary workshops; never the home ~/__WORKSHOP.
-
when: action is
test; place is~/__WORKSHOP*or/home/*/__WORKSHOP* - source: AGENTS.md, rule 8
BOS is tried and demonstrated on the development workshop (.env WORKSHOP_ROOT); the home ~/__WORKSHOP only when the owner asks.
-
when: action is
run,bootstrap,try,demonstrateorwrite; place is~/__WORKSHOP*or/home/*/__WORKSHOP* - source: AGENTS.md, the development workshop
An agent opens no pull request: it pushes development to revision, and the workflow opens revision → master.
-
when: role is
agent; action isopenorcreate; target isPR,pull-requestorpull - source: AGENTS.md, the routine
An agent pushes development, its own dev/ and revision without asking.
-
when: role is
agent; action ispush; target isdevelopment,revisionordev/* - source: AGENTS.md, rule 10
master, testing and releasing are pushed only with the owner's OK, and the reason.
-
when: action is
push; target ismaster,main,testingorreleasing - source: AGENTS.md, rule 10
Tags, releases and publishing (npm, the wiki's repository, images) are asked for first.
-
when: action is
tag,releaseorpublish - source: AGENTS.md, rule 10
Remotes and repository settings are changed only with the owner's OK.
-
when: action is
change,add,remove,setorrename; target isremote*,settings,secretsorwebhook* - source: AGENTS.md, rule 10
The owner's e-mail address identifies the owner only; it is not sent to services unless the owner asks.
-
when: action is
send,postorsubmit; target isemail,e-mailormail* - source: the owner, phase 2: security
An open question (BRAINSTORM.md Q) is never settled in code: the owner answers it in ORDERS.md.
-
when: action is
settle,decideoranswer; target isquestion*orBRAINSTORM* - source: AGENTS.md, read first
Blacksmith Organization System 1.14.1 · repository · documentation · generated from docs/ by scripts/gh-wiki.py, do not edit here
Home · 1.14.1
- Architecture
- Devlog
- Changelog
- For agents
-
Glossary
- BOS glossary
- Network
- Workshop
- Loop
- Elements