Update README.md #218
Open
Update README.md #218
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update readme to match template. Signed-off-by: Clay King <[email protected]>
cdisselkoen
reviewed
Jun 4, 2025
| # GitHub Model | ||
|
|
||
| In this example, we show how you can implement GitHub's repository permission access in Cedar. There are three “views” of GitHub permissions, corresponding to *Personal*, *Organization* and *Enterprise* accounts. We’ll focus on the *Organizational* view. Our model won’t be complete since this is a tutorial. We’ll aim for a subset of features that you are probably familiar with. | ||
| In this example, GitHub's repository permissions are implemented. . |
adpaco-aws
approved these changes
Jul 14, 2025
Comment on lines
+38
to
+51
| ### `pull` | ||
| Pull a repository. | ||
|
|
||
| ### `push` | ||
| Push a repository. | ||
|
|
||
| ### `fork` | ||
| Fork a repository. | ||
|
|
||
| ### `add_{reader, triager, writer, maintainer, admin}` | ||
| Add a user to the specified role of a repository. | ||
|
|
||
| ### `{create, delete, assign}_issue` | ||
| Perform the specified operation on an issue. |
There was a problem hiding this comment.
Not sure we should be using subsections in this case. It doesn't match what we do in the rest of the document (e.g., with entity types) and the description is too short for a subsection.
| #### Action for Writers: | ||
|
|
||
| A `User` of role `Writer` should be able to push to a repository and also edits its issues. | ||
| `User` entities with a role of `Writer` should be able to push to a repository and also edits its issues. |
There was a problem hiding this comment.
Suggested change
| `User` entities with a role of `Writer` should be able to push to a repository and also edits its issues. | |
| `User` entities with a role of `Writer` should be able to push to a repository and also edit their issues. |
| * The 1 `Organization` entity, `tiny_corp_owners`, has admin priveleges to all 3 repositories. | ||
| * The 1 `Team` entity, `team_that_can_read_everything`, has read priveleges to all 3 repositories. | ||
|
|
||
| Here are some authz requests to test, included in the `ALLOW` and `DENY` folders: |
There was a problem hiding this comment.
Why abbreviate here?
Suggested change
| Here are some authz requests to test, included in the `ALLOW` and `DENY` folders: | |
| Here are some authorization requests to test, included in the `ALLOW` and `DENY` folders: |
| * The 1 `Team` entity, `team_that_can_read_everything`, has read priveleges to all 3 repositories. | ||
|
|
||
| Here are some authz requests to test, included in the `ALLOW` and `DENY` folders: | ||
| * Alice tries to pull common_knowledge: ALLOW because she has read permissions through the `common_knowledge_writers` user group. |
There was a problem hiding this comment.
Since you're using the name with an underscore, I'd use backticks - so either
Suggested change
| * Alice tries to pull common_knowledge: ALLOW because she has read permissions through the `common_knowledge_writers` user group. | |
| * Alice tries to pull common knowledge: ALLOW because she has read permissions through the `common_knowledge_writers` user group. |
or
Suggested change
| * Alice tries to pull common_knowledge: ALLOW because she has read permissions through the `common_knowledge_writers` user group. | |
| * Alice tries to pull `common_knowledge`: ALLOW because she has read permissions through the `common_knowledge_writers` user group. |
Same comments goes for the next two cases (with uncommon_knowledge).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update readme to match template.
Signed-off-by: Clay King [email protected]