egeria-docs icon indicating copy to clipboard operation
egeria-docs copied to clipboard

Document process for requesting & creating a new code repository

Open planetf1 opened this issue 3 years ago • 5 comments

As we expand the breadth of egeria capabilities, much is this will happen through developing connectors.

Connectors may have their own community & lifecycle, and so may be nest managed in a unique repository

The process for requesting a new repository - what info is provided, who has responsibility for what should be documented

I will initially create a list here & then refactor as we go through the process on a new repository, and then refactor that material into the existing process documentation

Requester

  • [ ]

planetf1 avatar Jan 07 '22 14:01 planetf1

@planetf1 in terms of principles, I am assuming:

  • all connectors that are part of Egeria are documented in egeria-docs
  • the connectors abide by the same basic community guidelines, things like licensing, DCO etc
  • 'Connectors may have their own community & lifecycle' - I was thinking 'Connectors may have their own development and contributor communities. They may have their own lifecycle, but many follow the core Egeria release numbering'

davidradl avatar Jan 10 '22 10:01 davidradl

I will document tasks as I work through them, and later harvest into the docs

Creating a new repository

  • go to https://github.com/odpi
  • Click 'New' Screenshot 2022-01-11 at 10 01 15

planetf1 avatar Jan 11 '22 10:01 planetf1

Next go to the new repository -> settings

Features Wikis : Off Issues: On Sponsorship: Off Projects: On Preserve: On Discussions: Off

Merge - enable auto

User security and analysis

  • Enable dependabot, security, code alerts (this last step adds a commit containing a workflow definition)

Branches/Branch protection rule

  • add new rule for '*'
  • edit protection rules for main
  • Select 'require pull requests before merging', 'require status requests to pass before merging', Require branches to be up to date before merging, Require conversation resolution before merging,Include administrator -> create

planetf1 avatar Jan 11 '22 10:01 planetf1

Go back to https://github.com/organizations/odpi & settings -> installed apps Click on DCO -> configure Select new repository name in list of repos

Add a CODEOWNERS file (via clone/PR process) similar to:

 # SPDX-License-Identifier: Apache-2.0
 # Copyright Contributors to the ODPi Egeria project.

 # Code ownership for Egeria - see https://help.github.com/articles/about-codeowners/
 # Note that the LAST matching pattern will be effective so please more generic paths towards the top

 # Top level

 / @wbittles
 .github/ @planetf1

planetf1 avatar Jan 11 '22 10:01 planetf1

Commit the above change

Go back to new repository -> settings -> branches -> branch protection rules Under 'require status checks' type 'DCO' into search box. Select and Save

planetf1 avatar Jan 11 '22 10:01 planetf1