@veda-hq/niyam 0.7.7 → 0.7.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -774,7 +774,9 @@ where the owner reacts, never the slice's top or the `needs-owner` list. A
|
|
|
774
774
|
waiting decision with no proposal yet gets the command that posts one,
|
|
775
775
|
`niyam propose <issue> --page <page url>` with its number. A
|
|
776
776
|
reaction does not re-run a pull request's checks: the agent proposes before
|
|
777
|
-
it starts, and pre-push or a re-run of Work rules sees the 👍.
|
|
777
|
+
it starts, and pre-push or a re-run of Work rules sees the 👍. The shared
|
|
778
|
+
Guard takes the same 👍 for a slice that changes a guard file (#515), so one
|
|
779
|
+
👍 settles both.
|
|
778
780
|
|
|
779
781
|
**Many at once.** `propose` takes several issues, `niyam propose 12
|
|
780
782
|
30 41 --page <url>`, and asks for each in turn, each comment linking that page. Where the settings name an Approvals issue
|
|
@@ -1728,7 +1730,7 @@ tag and the commit. Install the attached package on each machine with pnpm,
|
|
|
1728
1730
|
once; nothing is built on install:
|
|
1729
1731
|
|
|
1730
1732
|
```bash
|
|
1731
|
-
pnpm add -g https://github.com/veda-hq/niyam/releases/download/v0.7.
|
|
1733
|
+
pnpm add -g https://github.com/veda-hq/niyam/releases/download/v0.7.9/veda-hq-niyam-0.7.9.tgz
|
|
1732
1734
|
```
|
|
1733
1735
|
|
|
1734
1736
|
The package puts one command on `PATH`, `niyam`. Since P-57 a release
|
|
@@ -1836,11 +1838,24 @@ slice joined counts, wherever it is:
|
|
|
1836
1838
|
- a `Decision:` on its Work item naming it;
|
|
1837
1839
|
- a batch answer on the Approvals issue the default branch's settings name
|
|
1838
1840
|
(`"approvals": N`), whose first line opens `Decision: approve` and names the
|
|
1839
|
-
slice, as the work rules read it (#501)
|
|
1841
|
+
slice, as the work rules read it (#501);
|
|
1842
|
+
- a 👍 on a proposal for it by an agent the settings name (`"agent"`), whose
|
|
1843
|
+
first line opens `Proposal:` and names the slice as its first `#N`. The 👍
|
|
1844
|
+
must be made after the slice joined and after the proposal's last edit, as
|
|
1845
|
+
the work rules read it (#515). A proposal GitHub no longer has counts
|
|
1846
|
+
nothing.
|
|
1840
1847
|
|
|
1841
1848
|
If GitHub cannot find the Approvals issue, Guard counts nothing from it and
|
|
1842
1849
|
goes on. Any other failure to read it fails closed.
|
|
1843
1850
|
|
|
1851
|
+
**Mergify's merge queue (#507).** Mergify tests a queued pull request in a draft of its own:
|
|
1852
|
+
- opened as `mergify[bot]` on a `mergify/merge-queue/` branch of the repository;
|
|
1853
|
+
- titled `merge queue: checking #A on main (sha)`, with `, stacked on #B` when it tests several.
|
|
1854
|
+
|
|
1855
|
+
Guard judges that draft's own diff once with each tested pull request's title, author and body. It refuses a file only when every tested pull request leads to that refusal. So a guard file passes when one tested pull request's approved slice names it, or when its onboard or Dependabot exemption holds for the draft's diff. Guard never passes a draft solely because it is Mergify's: a file still needs a tested pull request's owner-approved slice, unless an existing onboard or Dependabot exemption applies.
|
|
1856
|
+
|
|
1857
|
+
Any other draft, or one whose title names no pull request, is judged as itself, and so is any draft where work rules are off. A tested pull request GitHub cannot give fails closed.
|
|
1858
|
+
|
|
1844
1859
|
A name is a path, a folder ending in `/`, or a pattern where `*` matches
|
|
1845
1860
|
within one folder and `**` across them. The guard files are a floor every
|
|
1846
1861
|
repository has, everything under `.github/`, `.githooks/` and `.husky/`,
|
|
@@ -1858,9 +1873,17 @@ items, so no slice to name a change: the shared Guard judges no slice there,
|
|
|
1858
1873
|
and its log lists each change it would have asked one to name. It still
|
|
1859
1874
|
refuses what no slice passes: a job added under the name of a check the
|
|
1860
1875
|
ruleset requires, a job that could report `niyam-guard / judge` but is not
|
|
1861
|
-
the caller `onboard` writes,
|
|
1862
|
-
lists. With `work-rules` on, or no
|
|
1863
|
-
a `features` it cannot read
|
|
1876
|
+
the caller `onboard` writes, a caller pinned off a niyam release, and a pull
|
|
1877
|
+
request with more files than GitHub lists. With `work-rules` on, or no
|
|
1878
|
+
`features` listed, it judges every change; a `features` it cannot read
|
|
1879
|
+
refuses.
|
|
1880
|
+
|
|
1881
|
+
**The caller's pin only moves forward (#512).** The caller's pin picks which Guard judges every pull request, so with work rules on or off, Guard refuses a changed workflow that calls `shared-guard.yml` at:
|
|
1882
|
+
- anything but a `vX.Y.Z` tag, such as a commit sha;
|
|
1883
|
+
- a tag not on niyam's `main`;
|
|
1884
|
+
- a release older than the one the default branch's copy of that file pins.
|
|
1885
|
+
|
|
1886
|
+
No `**Guards:**` line passes these. `onboard` writes only a forward move to a release, so its pull requests pass.
|
|
1864
1887
|
|
|
1865
1888
|
Two changes pass unnamed: an onboard pull request
|
|
1866
1889
|
(`chore(niyam): onboard at vX.Y.Z`) whose every changed line only moves the
|
|
@@ -1882,8 +1905,8 @@ gives none), never the calling repository or the pull request, and judges
|
|
|
1882
1905
|
the caller's pull request with the caller's token. A repository calls it
|
|
1883
1906
|
from a workflow run by `pull_request_target` alone, whose one job,
|
|
1884
1907
|
`niyam-guard` (id and name), only calls
|
|
1885
|
-
`veda-hq/niyam/.github/workflows/shared-guard.yml@vX.Y.Z` (a release tag
|
|
1886
|
-
|
|
1908
|
+
`veda-hq/niyam/.github/workflows/shared-guard.yml@vX.Y.Z` (a release tag on
|
|
1909
|
+
niyam's `main`, never a branch or a commit sha), read-only, with no inputs or secrets; its
|
|
1887
1910
|
check is `niyam-guard / judge`. The default branch is the repository's own,
|
|
1888
1911
|
whatever its name. `niyam onboard` writes that caller,
|
|
1889
1912
|
`.github/workflows/niyam-guard.yml`, in every repository it onboards,
|