From bf2a8db7f3ead4dec0ca73a5ba4b4f668626593a Mon Sep 17 00:00:00 2001 From: Carlos Palhares Date: Mon, 14 Aug 2023 11:46:42 -0300 Subject: [PATCH] Document license compliance workflow (#8) --- docs/license-compliance.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/license-compliance.md diff --git a/docs/license-compliance.md b/docs/license-compliance.md new file mode 100644 index 0000000..37e4173 --- /dev/null +++ b/docs/license-compliance.md @@ -0,0 +1,27 @@ +# License Compliance + +Validade the liceses included in a project following the allowed licenses in [Power's OSS Guide](https://github.com/powerhome/oss-guide). + +## Installation 🛠 + +This workflow is included by the [Ruby](./ruby-gem.md) and [Yarn](./yarn-package.md) workflows. To include it manually: + +```yml +name: blorgh + +on: + push: + +jobs: + license-compliance: + uses: powerhome/github-actions-workflows/.github/workflows/ruby-gem.yml@main + with: + workdir: "${{ inputs.workdir }}" +``` + +## Inputs + +| **Input** | **Type** | **Required** | **Default** | +| --------- | -------- | ------------ | ---------------------------- | +| workdir | string | false | | +| decisions | string | true | doc/dependency_decisions.yml |