Skip to content

Commit

Permalink
CI: Add check-dependencies workflow (#120)
Browse files Browse the repository at this point in the history
Add workflow to check if our dependencies are compatible with our license.

Co-authored-by: per1234 <[email protected]>
  • Loading branch information
polldo and per1234 authored Sep 6, 2022
1 parent 677e08b commit fc1b5c3
Show file tree
Hide file tree
Showing 284 changed files with 55,226 additions and 0 deletions.
103 changes: 103 additions & 0 deletions .github/workflows/check-dependencies-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-dependencies-task.md
name: Check Dependencies

env:
# See: https://github.com/actions/setup-go/tree/v2#readme
GO_VERSION: "1.16"

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
on:
push:
paths:
- ".github/workflows/check-dependencies-task.ya?ml"
- ".licenses/**"
- ".licensed.json"
- ".licensed.ya?ml"
- "Taskfile.ya?ml"
- "**/go.mod"
- "**/go.sum"
pull_request:
paths:
- ".github/workflows/check-dependencies-task.ya?ml"
- ".licenses/**"
- ".licensed.json"
- ".licensed.ya?ml"
- "Taskfile.ya?ml"
- "**/go.mod"
- "**/go.sum"
workflow_dispatch:
repository_dispatch:

jobs:
check-cache:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install licensed
uses: jonabc/setup-licensed@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Install Go
uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}

- name: Install Task
uses: arduino/setup-task@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Update dependencies license metadata cache
run: task --silent general:cache-dep-licenses

- name: Check for outdated cache
id: diff
run: |
git add .
if ! git diff --cached --color --exit-code; then
echo
echo "::error::Dependency license metadata out of sync. See: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-dependencies-task.md#metadata-cache"
exit 1
fi
# Some might find it convenient to have CI generate the cache rather than setting up for it locally
- name: Upload cache to workflow artifact
if: failure() && steps.diff.outcome == 'failure'
uses: actions/upload-artifact@v2
with:
if-no-files-found: error
name: dep-licenses-cache
path: .licenses/

check-deps:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install licensed
uses: jonabc/setup-licensed@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Install Go
uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}

- name: Install Task
uses: arduino/setup-task@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Check for dependencies with unapproved licenses
run: task --silent general:check-dep-licenses
81 changes: 81 additions & 0 deletions .licensed.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# See: https://github.com/github/licensed/blob/master/docs/configuration.md

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies/AGPL-3.0/.licensed.yml
allowed:
# Based on: https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses
- gpl-1.0-or-later
- gpl-1.0+ # Deprecated ID for `gpl-1.0-or-later`
- gpl-2.0-or-later
- gpl-2.0+ # Deprecated ID for `gpl-2.0-or-later`
- gpl-3.0-only
- gpl-3.0 # Deprecated ID for `gpl-3.0-only`
- gpl-3.0-or-later
- gpl-3.0+ # Deprecated ID for `gpl-3.0-or-later`
- lgpl-2.0-or-later
- lgpl-2.0+ # Deprecated ID for `lgpl-2.0-or-later`
- lgpl-2.1-only
- lgpl-2.1 # Deprecated ID for `lgpl-2.1-only`
- lgpl-2.1-or-later
- lgpl-2.1+ # Deprecated ID for `lgpl-2.1-or-later`
- lgpl-3.0-only
- lgpl-3.0 # Deprecated ID for `lgpl-3.0-only`
- lgpl-3.0-or-later
- lgpl-3.0+ # Deprecated ID for `lgpl-3.0-or-later`
- agpl-1.0-or-later
- agpl-3.0-only
- agpl-3.0 # Deprecated ID for `agpl-3.0-only`
- agpl-3.0-or-later
- fsfap
- apache-2.0
- artistic-2.0
- clartistic
- sleepycat
- bsl-1.0
- bsd-3-clause
- cecill-2.0
- bsd-3-clause-clear
# "Cryptix General License" - no SPDX ID (https://github.com/spdx/license-list-XML/issues/456)
- ecos-2.0
- ecl-2.0
- efl-2.0
- eudatagrid
- mit
- bsd-2-clause # Subsumed by `bsd-2-clause-views`
- bsd-2-clause-netbsd # Deprecated ID for `bsd-2-clause`
- bsd-2-clause-views # This is the version linked from https://www.gnu.org/licenses/license-list.html#FreeBSD
- bsd-2-clause-freebsd # Deprecated ID for `bsd-2-clause-views`
- ftl
- hpnd
- imatix
- imlib2
- ijg
# "Informal license" - this is a general class of license
- intel
- isc
- mpl-2.0
- ncsa
# "License of Netscape JavaScript" - no SPDX ID
- oldap-2.7
# "License of Perl 5 and below" - possibly `Artistic-1.0-Perl` ?
- cc0-1.0
- cc-pddc
- psf-2.0
- ruby
- sgi-b-2.0
- smlnj
- standardml-nj # Deprecated ID for `smlnj`
- unicode-dfs-2015
- upl-1.0
- unlicense
- vim
- w3c
- wtfpl
- lgpl-2.0-or-later with wxwindows-exception-3.1
- wxwindows # Deprecated ID for `lgpl-2.0-or-later with wxwindows-exception-3.1`
- x11
- xfree86-1.1
- zlib
- zpl-2.0
- zpl-2.1
# Based on individual license text
- eupl-1.2
19 changes: 19 additions & 0 deletions .licenses/go/github.com/antihax/optional.dep.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: github.com/antihax/optional
version: v1.0.0
type: go
summary:
homepage: https://pkg.go.dev/github.com/antihax/optional
license: mit
licenses:
- sources: LICENSE
text: |
The MIT License (MIT)
Copyright (c) 2016 Adam Hintz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
notices: []
Loading

0 comments on commit fc1b5c3

Please sign in to comment.