Home

Welcome to the .github wiki!

Usages

This .github repository expects to be used both as GitHub metafiles and as repository templates. You can choose either, or also use features both of them at the same time.

as GitHub metafiles

This repository stores Community Health Files with builtin feature of GitHub. With this features, the following supported files in this repository will be implicitly applied to ALL of user repository as default.

• README.md (this file)
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• Issue Templates: .github/ISSUE_TEMPLATE/*
• PR Template: .github/PULL_REQUEST_TEMPLATE.md

If you would override above files in specific repository, simply creating file in the repository. In case you need not to explicitly include above files in your code basis, all you have to do is to fork this repository as you like, which copy GitHub metafiles onto your repository.

as Repository Templates

Since we can make this repository as public repository templates, you can also levarage with cloning initial files in your repository as well as GitHub metafiles. So you can easily create your repository from scaffolded files with creating repository from template. For this usage, firstly you have to fork this repository same as above, then create your repository from the forked repository.

If you can successfully create your repository from fork, you can confirm it the descriptions like generated from ${YOUR_USERNAME}/.github bottom of the your repository name in code explorer.

Features

This repository contains the following files as templates. As some of them will require to additional setup, or you can customize it from default values. Please follow the detailed descriptions for dedicated Wiki Pages in this repository.

Git/GitHub metafiles

• .gitignore (minimal)
• .gitattributes
• CODEOWNERS

Setup repository

• @azu/github-label-setup
  • CLI tools for declarative label presetting
  • Please follow the instructions in Wiki page
  • config: .github/config/label-defaults.json

Managing Issues/PRs

• Issue Labeler
  • actions: github/issue-labeler
  • config: .github/config/issue-labels.yaml
• Stale Issue
  • actions: actions/stale
• PR Labeler
  • actions: actions/labeler
  • config: .github/config/pr-labels.yaml
• Semantic PRs
  • config: .github/semantic.yaml
  • Require installation of Semantic PR as GitHub Apps

Dependencies updates

• renovate
  • config: .github/renovate.json
  • Require installation of Mend Renovate as GitHub Apps

Release automation

• release-please
  • actions: google-github-actions/release-please-action
  • configs:
    • .release-please-manifest.json
    • .github/config/release-please-config.json

Workflows

We have workflows below by default, where actual workflow files are located in .github/workflows/*. The workflow triggers are configured as following:

• Triage Issue
• Triage PRs
• Stale Issues
• Release Please

As well as GitHub Actions described in Features section above, we have also implemented following GitHub Actions for making pipeline more efficient.

• technote-space/assign-author

Caveats

• Referencing default CONTRIBUTING.md

Good to know

TBD