Skip to content
Closed
Changes from all commits
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
77 changes: 77 additions & 0 deletions .github/workflows/python-license-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will run license check for the Python project
# For more information see: https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-python

name: Python license check

on:
push:
branches: [ "main" ]
paths:
- 'client/python/**'
pull_request:
branches: [ "main" ]
paths:
- 'client/python/**'

jobs:
build:

runs-on: ubuntu-latest

steps:
- name: Checkout Polaris project
uses: actions/checkout@v4

- name: Set up Python 3.7
uses: actions/setup-python@v5
with:
python-version: '3.7'

- name: Cache Poetry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be problematic as we have gitignore for poetry.lock. In this case, it won't invalid the cache right?

Copy link
Author

@DaniilRoman DaniilRoman Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good point, we need to have poetry.lock in order to cache this properly and we could even use this config cache: 'poetry' of actions/setup-python@v4 GitHub action (here's this docs section).

Without having poetry.lock we can only cache based on pyptoject.toml which doesn't cover transitive dependencies.
I've also thought about generating poetry.lock on CI but for this we need to have poetry first and when we install poetry, it installs dependencies as well - so, it wouldn't work

What about removing poetry.lock from .gitignore and creating it and managing for the future changes? 🤔
Or is it good enough to create a hash key based on myproject.toml instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick check shows it got excluded by #246. @dimas-b / @snazy can you provide more context on why we exclude that?

id: cache-poetry
uses: actions/cache@v4
with:
path: ~/.cache/pypoetry
key: ${{ runner.os }}-poetry-${{ hashFiles('client/python/poetry.lock') }}
restore-keys: |
${{ runner.os }}-poetry-

- name: Install Poetry
if: steps.cache-poetry.outputs.cache-hit != 'true'
run: |
curl -sSL https://install.python-poetry.org | python3 -
export PATH="$HOME/.local/bin:$PATH"

- name: Install dependencies and pip-licenses
working-directory: client/python
run: |
poetry install
pip install pip-licenses

- name: Check Licenses
working-directory: client/python
run: |
pip-licenses --partial-match --fail-on="GPL;AGPL;LGPL;SSPL;EPL"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jbonofre can u help review if this rule is sufficient?