From 474e26b295794cf6bebe69f626250f447c68292f Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Tue, 21 Feb 2023 13:41:52 -0500 Subject: [PATCH 1/2] Add cisagov repository configuration blurb to the README Add instructions on configuring a cisagov repository to receive automatic updates. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 50dec2e..6bab636 100644 --- a/README.md +++ b/README.md @@ -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. + ## Usage ## ### Inputs ### @@ -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 From 45ca44ba74c8dfe3d724290e7432e2fa52e4712e Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Fri, 24 Feb 2023 11:58:11 -0500 Subject: [PATCH 2/2] Update wording in the README Clarify that a repository should be based on any publicly accessible parent and offer the `cisagov` skeleton repositories as options. Co-authored-by: dav3r --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bab636..2211c1f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,8 @@ lineage: 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. Ensure your project is based on a publicly accessible parent repository + (such as a [`cisagov` 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)