Skip to content

A Github Action to Check and Create Open Source License in a Repo.

License

Notifications You must be signed in to change notification settings

ephraimduncan/license-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Add License Action

GitHub Action to add a License to a Repository

This is a GitHub Action that automatically add a specified type of open source license to a repository that does not have a license

Setup

  1. Add a workflow file to your project (e.g. .github/workflows/license.yml):

    name: Add License
    
    on:
      push:
        branches:
          - main
          - master
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - name: Setup Node.js
            uses: actions/setup-node@v1
            with:
              node-version: 12.x
          - name: Adding License
            uses: dephraiim/license-action@v1
            with:
              LICENSE_TYPE: MIT
              AUTHOR: Ephraim Atta-Duncan
              PROJECT_NAME: License Action

Configuration

Options

You can configure the action further with the following options:

  • LICENSE_TYPE: The type of License you want to add to your repo. (default: MIT) (required: false)
  • AUTHOR: The Author of the repository. (required: true)
  • PROJECT_NAME: The name of the project. Required by some licenses. (required: false)

License Types

  • AGPL
  • Apache
  • BSD
  • CC-BY
  • CC-BY-NC
  • CC-BY-NC-SA
  • CC-BY-SA
  • CC0
  • GPL
  • ISC
  • LGPL
  • MIT
  • MPL
  • Unlicense

Supported Licenses

The action supports the following licenses:

Development

Suggestions and contributions are always welcome!

LICENSE

MIT

About

A Github Action to Check and Create Open Source License in a Repo.

Resources

License

Stars

Watchers

Forks

Packages

No packages published