detached a7f3fdb

#32 docs(ci): describe what a job token with contents: write may push

state
merged · a7f3fdb · fast-forward
branch
docs/job-token-writes → main
opened
bnema ·
updated
CommitSubjectAuthorDateSignatureStatus
a7f3fdbdocs(ci): describe what a job token with contents: write may pushbriceGPG Verified

Checks 0

no checks

1 file · +7 -1
no checks
M docs/ci.md +7 -1
@@ -59,7 +59,13 @@ Per-event rules are in [ci-events.md](ci-events.md).
5959
6060 ## Job token
6161
62-Every job gets `github.token` (`ermitegh_…`). It reads the run's repository (even private) over Git and the REST subset below, writes nothing, and expires with the job. It is not listed in `ermite token list`.
62+Every job gets `github.token` (`ermitegh_…`). It expires with the job and is not listed in `ermite token list`.
63+
64+- By default it reads the run's repository (even private) over Git and the REST subset below, and writes nothing.
65+- In a trusted run, `permissions: contents: write` lets it push branches and tags to that repository and publish [releases](releases.md). A push that changes `.github/workflows` is refused, as on GitHub.
66+- `pull-requests: write` gives it `mr:write` on that repository.
67+- An untrusted run gets every `write` lowered to `read`.
68+- A push or a tag made with it starts no run. A workflow that creates a tag and releases it does both in the same run (`needs:`).
6369
6470 ## Actions
6571
@@ -59,7 +59,13 @@ Per-event rules are in [ci-events.md](ci-events.md).
59 59
60 ## Job token60 ## Job token
61 61
62-Every job gets `github.token` (`ermitegh_…`). It reads the run's repository (even private) over Git and the REST subset below, writes nothing, and expires with the job. It is not listed in `ermite token list`.62+Every job gets `github.token` (`ermitegh_…`). It expires with the job and is not listed in `ermite token list`.
63+
64+- By default it reads the run's repository (even private) over Git and the REST subset below, and writes nothing.
65+- In a trusted run, `permissions: contents: write` lets it push branches and tags to that repository and publish [releases](releases.md). A push that changes `.github/workflows` is refused, as on GitHub.
66+- `pull-requests: write` gives it `mr:write` on that repository.
67+- An untrusted run gets every `write` lowered to `read`.
68+- A push or a tag made with it starts no run. A workflow that creates a tag and releases it does both in the same run (`needs:`).
63 69
64 ## Actions70 ## Actions
65 71

Comments0 open / 0

no comments yet.

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
l
merge request: the list of files (j k move, enter opens, esc back)
M
merge request: the merge menu; there 1–3 pick the mode, D deletes the branch, enter merges
R
merge request: mark the head read
esc
close a dialog, leave a field

Branches 2

Tags 41

↑↓ moveenter openesc close