Skip to content

Add directions for enrolling cisagov repositories in Lineage updates#66

Open
mcdonnnj wants to merge 2 commits intodevelopfrom
improvement/add_enrolling_instructions
Open

Add directions for enrolling cisagov repositories in Lineage updates#66
mcdonnnj wants to merge 2 commits intodevelopfrom
improvement/add_enrolling_instructions

Conversation

@mcdonnnj
Copy link
Copy Markdown
Member

🗣 Description

This pull request updates the README to add directions to enable Lineage updates for repositories with maintainers outside of our group.

💭 Motivation and context

This will help any other members of the cisagov org get these automatic updates in their repositories if they so desire.

🧪 Testing

Automated tests pass.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • All new and existing tests pass.

Add instructions on configuring a cisagov repository to receive
automatic updates.
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels Feb 24, 2023
@mcdonnnj mcdonnnj self-assigned this Feb 24, 2023
Copy link
Copy Markdown
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

LGTM with one small take-it-or-leave-it suggestion. 👍

Comment thread README.md Outdated
Clarify that a repository should be based on any publicly accessible
parent and offer the `cisagov` skeleton repositories as options.

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
@mcdonnnj mcdonnnj requested a review from jsf9k February 24, 2023 17:55
Copy link
Copy Markdown
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

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

I left a couple of extremely minor suggestions, but I still approve this PR whether you take them or leave them.

Comment thread README.md
Comment on lines +45 to +48
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)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Personally, I'd add periods to the end of these since they are complete sentences. Take it or leave it.

Suggested change
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)
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).

Comment thread README.md
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
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants