Document license compliance workflow (#8)

powerhome · Aug 14, 2023 · bf2a8db · bf2a8db
1 parent 0a95baf
commit bf2a8db
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/docs/license-compliance.md 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 |