Skip to content

github/setup-licensed

Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.

setup-licensed

A GitHub Action to set up github/licensed for use in action workflows, at the specified version input and target platform. The action will fail if licensed isn't available for the specified version and target platform.

Installing licensed as a Ruby gem

Installing licensed as a Ruby gem requires an Actions environment that supports gem install. The default system Ruby installation that is available in GitHub Actions runners does not support user-installed gems. Please use ruby/setup-ruby or a similar action in your workflow before using this action in order to install licensed as a Ruby gem.

Installing licensed as an executable

Licensed is not available as an executable for any version >= 4.0. Please install licensed as a Ruby gem for these versions

Licensed executables are provided for macOS and linux platforms. When installing a licensed executable, this action will overwrite any version of the executable already installed at the install-dir input.

Installing licensed as an executable requires making API calls to GitHub which can be rate limited and significantly slow down a GitHub Action workflow run. Rate limiting is more likely to happen when using ${{ secrets.GITHUB_TOKEN }} for the github_token input or when leaving the github_token input empty. If you are hitting frequent rate limiting and long action runtimes, please set github_token to a user PAT or install licensed as a Ruby gem.

Usage

See action.yml

list dependencies:

steps:
- uses: actions/checkout@v3

# setup application environment
- uses: actions/setup-node@v3
- run: npm install # install dependencies in local environment

# setup ruby environment before running github/setup-licensed
- uses: ruby/setup-ruby@v1
  with:
    ruby-version: ruby

- uses: github/setup-licensed@v1
  with:
    version: '4.x' # required: supports matching based on string equivalence or node-semver range
    install-dir: /path/to/install/at # optional: defaults to /usr/local/bin
    github_token: # optional: allows users to make authenticated requests to GitHub's APIs

- run: licensed list

For an end-to-end solution to cache and check dependency metadata using GitHub Actions, see licensed-ci.yaml

License

The scripts and documentation in this project are released under the MIT License

Maintainers

  • @ajhenry
  • @lumaxis

Support

You can expect the following support. See SUPPORT for more information.

Contributions

Contributions are welcome! See CONTRIBUTING.md for more information on how to get involved.

Acknowledgement

Huge thank you and appreciation to @jonabc for championing license compliance and maintaining licensed over the years.

About

Set up your GitHub Actions workflow with a specific version of github/licensed

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published