Skip to content

Add directions for enrolling cisagov repositories in Lineage updates #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add directions for enrolling cisagov repositories in Lineage updates #66

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
474e26b
Add cisagov repository configuration blurb to the README
mcdonnnj Feb 21, 2023
45ca44b
Update wording in the README
mcdonnnj Feb 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ lineage:
remote-url: https://github.com/felddy/extra-skel-sauce.git
```

### Configure a [cisagov] repository for automatic Lineage updates ###

If you are a [cisagov] repository maintainer and wish for your repository to
receive Lineage updates you must do the following:

1. Ensure your project is properly based on a [Skeleton repository](https://github.com/cisagov/development-guide/blob/develop/project_setup/skeleton-list.md)
1. Provide [`write`](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations)
access to [@cisagovbot](https://github.com/cisagovbot) or [@cisagov/team-ois](https://github.com/orgs/cisagov/teams/team-ois)

Once these changes are implemented your repository should see new pull requests
generated as appropriate during the regular Lineage organization checks.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a suggestion. Take it or leave it; it does not impact my approval.

Suggested change
generated as appropriate during the regular Lineage organization checks.
generated when appropriate during the regular Lineage organization checks.


## Usage ##

### Inputs ###
Expand Down Expand Up @@ -102,3 +114,5 @@ dedication](https://creativecommons.org/publicdomain/zero/1.0/).
All contributions to this project will be released under the CC0
dedication. By submitting a pull request, you are agreeing to comply
with this waiver of copyright interest.

[cisagov]: https://github.com/cisagov