Skip to content

CI: Add check-dependencies workflow #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
CI: Add check-dependencies workflow
  • Loading branch information
polldo committed Sep 5, 2022
commit 8c9a44d855276bcd2c9eb364e710596aec318955
99 changes: 99 additions & 0 deletions .github/workflows/check-dependencies-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# 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 --intent-to-add .
git diff --color --exit-code

# 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 Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,22 @@ tasks:
-coverprofile=coverage_unit.txt \
{{.TEST_LDFLAGS}} \
{{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml
general:cache-dep-licenses:
desc: Cache dependency license metadata
cmds:
- |
if ! which licensed &>/dev/null; then
echo "licensed not found or not in PATH. Please install: https://github.com/github/licensed#as-an-executable"
exit 1
fi
- licensed cache

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml
general:check-dep-licenses:
desc: Check for unapproved dependency licenses
deps:
- task: general:cache-dep-licenses
cmds:
- licensed status