manaakiwhenua / manaakiwhenua-standards

A GitHub action to check a respitory meets the Maanaki Whenua - Landcare Research repository standards.

Manaaki Whenua - Landcare Research GitHub Repository Standards

Each time changes are pushed to a repository this GitHub action checks that the repository meets the Manaaki Whenua - Landcare Research's GitHub repository standards and reports the status as either passing or failing via a repository status badge.

Current standards

For a repository to meet the Manaaki Whenua standards the repository must contain:

• A README.md file that is non-empty.
• A LICENSE file that is non-empty. The LICENSE file can be named 'LICENSE', 'LICENSE.txt', or 'LICENSE.md'. Alternatively, in the case of LGPL, both 'COPYING' and 'COPYING.LESSER'.

Inputs

No inputs required.

Outputs

No outputs required.

Example Usage

Note, this action requires the checkout action.

uses : 'actions/checkout@v2'
uses : actions/manaakiwhenua-standards@v0.2.2

Installation Instructions

The standards files need to be tracked as part of the repository, therefore you will need to create and add them to your repository as you would for your other code and files.

Please create the directory .github/workflows in your repository if it does not already exist, and then create a .github/workflows/main.yml file containing the following code:

name: manaakiwhenua-standards

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
      - name : 'Checkout'
        uses : 'actions/checkout@v3'
      - name : 'manaakiwhenua-standards'
        uses : manaakiwhenua/manaakiwhenua-standards@v0.2.2

Add the following code to your README.md file. Please change the <NAME OF YOUR REPOSITORY> in the following line of code to your repository name.

[![manaakiwhenua-standards](https://github.com/manaakiwhenua/<NAME OF YOUR REPOSITORY>/workflows/manaakiwhenua-standards/badge.svg)](https://github.com/manaakiwhenua/manaakiwhenua-standards)