mediocregopher/dehub
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

changes from proofreading tutorials

Browse Source 
---
type: change
description: changes from proofreading tutorials
fingerprint: ADE01wwr4F9UETZtq7ojdfupCUvCBxsr31X6bqvsJ7Hg
credentials:
- type: pgp_signature
  pub_key_id: 95C46FA6A41148AC
  body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl7VT0gACgkQlcRvpqQRSKzgHg/9EK8zgsFggsQI2k0RskBWVFfU56gVEZ7CFC6l+LvlswZ6m4bb6bfxD9MxRihGbMWfejDIcxim/Ui3ftHzMDhAwRj7SBoW4DWow0o6vMd6ESeo6jnhaN2fKk7YpFrt7HbQ/GM8oa11LXYR81tvqwiulZzIdCa8QAx6oD93MQWOAt7VbQ2eSyM7l5V3gTG7zsTfViZnLQZ7UFG0+s/yKHMDeqkV50Wcm7kt16TY5I1Ir1m0tZ0KTfF7/wA49k8j/ie1BuXy0Pw4fQwGGXPqIqrTz+8175A/LAtfPupoWzg3BjQ1MPfqUVKKF8F4aIt8A1tTkqELtM+ENGag7cMTOYmhSCnH1cAecCYpTfLYQQO78BxSzo2aw0xIlNN+mX1ycKsCkXhcU0w8DnFPbHraDiH01m92Czhh5V+dGZK1YiDL01Ye89kG/UuZpQyT3bh74rgUS9MRxJ5MESgXTW7OXep5TbO8wrwssLsiTJlFvPb0Gy76uz4rD31e7g2cXCcVrAmD/gdzpMQp0MQDqSv2VZzF4tn6k/w9sODSAxry3cDmfGnquyBWARvNYKsla2PEbKB+rjjnYmTfqjIGRxksThrnVUw06FTOYz12IkaDljO+O5v1P6VgHVcQ5EKxh38+MlU7UKx1zvjuvM8EleoqVOxaG9LI0hxlFAhyRaSYgnbjRe8=
  account: mediocregopher
This commit is contained in:
mediocregopher 2020-06-01 12:56:20 -06:00
parent a709a43696
commit 68b4e68177
3 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/tut1.md
View File

@ -64,9 +64,9 @@ git add --all
dehub commit --as tut change dehub commit --as tut change
``` ```
Like when you made a comment commit this will pop up with your editor asking for Like when you made a comment commit, this will pop up with your editor asking
a description of the changes. Fill it in with something like `Initialize the for a description of the changes. Fill it in with something like `Initialize the
project` and save/close the editor. Depending on your pgp key settings you'll project` and save+close the editor. Depending on your pgp key settings you'll
likely be prompted for your pgp key password at this point. After that the likely be prompted for your pgp key password at this point. After that the
commit has been created! commit has been created!

23
docs/tut2.md
View File

@ -68,20 +68,21 @@ dehub commit --as tut change --descr 'add new restricted tot account'
### Access Controls ### Access Controls
Each access control is an action/filters pair. For any commit being verified, Each access control is an action+filters pair. For any commit being verified,
the access controls defined in its parent commit are iterated through, in order, the access controls defined in its parent commit are iterated through, in order,
until one is found whose filters all match the commit being verified. The action until one is found whose filters all match the commit being verified. The action
for that access control, either `allow` or `deny`, is then taken. for that access control, either `allow` or `deny`, is then taken.
If no access controls are defined, or none match, then the default access If no access controls are defined, or none match, then the default access
controls are used. These are explicitly defined in the [SPEC](SPEC.html), but controls are used. These are explicitly defined in the
the general effect of them is to require that all commits have one signature [SPEC](SPEC.html#default-access-controls), but the general effect of them is to
from any of the project's accounts. require that all commits have one signature from any of the project's accounts.
### Access Control Filters ### Access Control Filters
There are many different filter types, so only the ones used in the tutorial There are many different filter types, so only the ones used in the tutorial
will be explained. An exhaustive listing can be found in the [SPEC](SPEC.html). will be explained. An exhaustive listing can be found in the
[SPEC](SPEC.html#filter).
The `signature` filter matches commits which have a signature credential created The `signature` filter matches commits which have a signature credential created
by any one of the specified accounts. The `files_changed` filter matches commits by any one of the specified accounts. The `files_changed` filter matches commits
@ -149,13 +150,15 @@ dehub commit --as tot change --descr 'tut is a butt'
``` ```
Somewhat unexpectedly, the commit has been created! You can see it by doing `git Somewhat unexpectedly, the commit has been created! You can see it by doing `git
show`. Is dehub broken? show`. This shouldn't be possible though, because the previous commit disallowed
anyone but `tut` from changing files within the `.dehub/` directory. Is dehub
broken?
The fact is that, regardless of whether or not the `dehub` tool allows one to The fact is that, regardless of whether or not the `dehub` tool allows one to
create this commit, `tut` can create this commit. The important thing is that create this commit, `tot` can create this commit. The important thing is that
`tot` is able to notice that it's been created and do something about it. In a `tut` is able to notice that it's been created and do something about it. In a
real-world situation, both `tot` and `tut` would be using different computers, real-world situation, both `tot` and `tut` would be using different computers,
and when `tot` (or anyone else) receives the commit from `tut` they will try to and when `tut` (or anyone else) receives the commit from `tot` they will try to
verify it, fail to do so, and ignore it. verify it, fail to do so, and ignore it.
If you perform `dehub verify` you will be greeted with the following error: If you perform `dehub verify` you will be greeted with the following error:
@ -246,7 +249,7 @@ Running `dehub verify` now should fail, even though the commit remains the same.
The only difference is the branch name; the commit is allowed in branches with The only difference is the branch name; the commit is allowed in branches with
the prefix `tot/`, and disallowed otherwise. the prefix `tot/`, and disallowed otherwise.
Finally, reverse that cherry-pick to make main verifiable again: Finally, reverse that cherry-pick to make `main` verifiable again:
``` ```
git reset --hard "$(git rev-list HEAD | tail -4 | head -n1)" git reset --hard "$(git rev-list HEAD | tail -4 | head -n1)"

5
docs/tut3.md
View File

@ -94,8 +94,7 @@ filter, such that this access control will match only if the commit _does not_
have signature credentials from 2 different accounts. have signature credentials from 2 different accounts.
The total effect of this access control is to deny any commits to `main` which The total effect of this access control is to deny any commits to `main` which
do not have signature credentials from 2 different accounts. In effect, commit have not been signed-off by 2 different accounts.
sign-off.
## Step 1: Some Changes to Merge ## Step 1: Some Changes to Merge
@ -187,7 +186,7 @@ credentials:
account: tut account: tut
``` ```
There is now enough credentials to combine both commits in the `tot/echo-script` There are now enough credentials to combine the commits in the `tot/echo-script`
branch into a single commit on the `main` branch. branch into a single commit on the `main` branch.
## Step 3: Combination ## Step 3: Combination