GitHub Config and CI - NetworkGradeLinux/mion-docs GitHub Wiki

Adding a new repo

When a new repo has been added to the NGL GitHub, there are a few things which need to be configured:

1. Repo settings

  • Settings -> Options ->

    • Features -> disable Wikis and Projects
    • Merge Button -> disable all but "Allow rebase merging" (this keeps the history very clean)
    • Danger Zone -> make sure the visibility (public/private) is correct
  • Settings -> Manage access ->

    • Make sure the correct groups have access - use groups rather than individual user accounts
  • Issues -> Labels ->

    • Update the labels to match those used in the other repos - names, descriptions and colours - use meta-mion as a ref
  • In the top level Mion repo

    • Add the new repo to the project board as a "Linked Repo" so that issues can be added to the project board

2. GitHub actions

In order for GitHub builds in the mion-ci repo to be triggered by commits from other repos it is necessary to add a repo dispatch. An example of this can be found in .github/workflows/workflow_dispatch.yml in most of the main NGL repos.

3. Slack

Subscribe to the repo in the NGL/gh-notify channel with the following command

/github subscribe NetworkGradeLinux/<repo>

This will enable notifications to the channel for issues, pulls, commits and releases by default

⚠️ **GitHub.com Fallback** ⚠️