Skip to content

Commit dc90f7b

Browse files
ptheywoodmondus
andcommitted
Relicence to dual-licenced AGPL-3.0-only + commercial with CLA
Adds a github actions workflow which manages CLA signing/checking Co-authored-by: Paul Richmond <p.richmond@sheffield.ac.uk>
1 parent 74c3ca9 commit dc90f7b

8 files changed

Lines changed: 733 additions & 14 deletions

File tree

.github/workflows/cla.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "CLA Assistant"
2+
3+
# The CLA assistant workflow must have write scope for pull request comments, and so must be ran on pull_request_target, and issue comments.
4+
on:
5+
issue_comment:
6+
types: [created]
7+
pull_request_target:
8+
types: [opened,closed,synchronize]
9+
10+
# Explicit permissions
11+
permissions:
12+
actions: write
13+
contents: read
14+
pull-requests: write
15+
statuses: write
16+
17+
jobs:
18+
CLAAssistant:
19+
# Only run the job at all for pull_request_targets or comments which contain one of two strings.
20+
# Contains is used to allow whitespace in the comment which is checked in an inner step.
21+
if: github.event_name == 'pull_request_target' || (contains(github.event.comment.body, 'recheck') || contains(github.event.comment.body, 'I have read the CLA Document and I hereby sign the CLA'))
22+
runs-on: ubuntu-latest
23+
steps:
24+
# If triggered by an issue comment, compare a trimmed version to allow for additional whitespace.
25+
# Uses JS to avoid having to do shell character escaping nicely
26+
- name: "Check comment"
27+
id: check_trimmed_comment
28+
if: github.event_name == 'issue_comment'
29+
uses: actions/github-script@v8
30+
with:
31+
script: |
32+
const comment = context.payload.comment.body;
33+
const trimmed = comment.trim();
34+
if (trimmed === 'recheck' || trimmed === 'I have read the CLA Document and I hereby sign the CLA') {
35+
return 'true';
36+
} else {
37+
return 'false';
38+
}
39+
result-encoding: string
40+
41+
# For pull_request_triggers, or comments which contained (whitespace wrapped) trigger phrases, run the contributor assistant
42+
- name: "Contributor Assistant"
43+
if: github.event_name == 'pull_request_target' || steps.check_trimmed_comment.outputs.result == 'true'
44+
uses: FLAMEGPU/contributor-assistant-github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08
45+
env:
46+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47+
PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_SIGNATURES_PAT }}
48+
with:
49+
path-to-signatures: 'signatures/v1/cla.json'
50+
path-to-document: 'https://flamegpu.com/cla/'
51+
branch: 'main'
52+
# allowlist: bot*
53+
remote-organization-name: FLAMEGPU
54+
remote-repository-name: cla-signatures
55+
lock-pullrequest-aftermerge: false

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
---
33
cff-version: 1.2.0
44
title: "FLAME GPU"
5-
license: MIT
5+
license: AGPL-3.0-only
66
repository-code: "https://github.com/FLAMEGPU/FLAMEGPU2"
77
url: "https://flamegpu.com"
88
version: "2.0.0-rc.2"

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,16 @@ Similarly if submitting a new example model, it will need to include it's own `C
7777
This ensure that users on both Linux and Windows can continue to build FLAME GPU 2.
7878

7979
## License
80-
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE.md).
80+
81+
FLAME GPU is available under two licenses:
82+
83+
- [AGPL-3.0-only license](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md) for open source usage
84+
- A commercial licenses for cases where the use of the open source AGPL-licensed version is not possible or desirable. Please see [flamegpu.com/license/download/](https://flamegpu.com/download/license/) for more information.
85+
86+
### Contributor License Agreement (CLA)
87+
88+
Before we can accept your pull request, you need to sign our [CLA](https://flamegpu.com/cla/) so that we can redistribute any changes via our dual license model.
89+
Our CLA assistant should check and prompt you to sign the CLA when you create your pull request.
8190

8291
## Creating a Release
8392

LICENSE.md

Lines changed: 657 additions & 5 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FLAME GPU 2
22

3-
[![MIT License](https://img.shields.io/github/license/FLAMEGPU/FLAMEGPU2)](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md)
3+
[![AGPL-3.0 License](https://img.shields.io/badge/license-AGPL--3.0-blue)](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md)
44
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/FLAMEGPU/FLAMEGPU2?include_prereleases)](https://github.com/FLAMEGPU/FLAMEGPU2/releases/latest)
55
[![GitHub issues](https://img.shields.io/github/issues/FLAMEGPU/FLAMEGPU2)](https://github.com/FLAMEGPU/FLAMEGPU2/issues)
66
[![DOI](https://zenodo.org/badge/34064755.svg)](https://zenodo.org/badge/latestdoi/34064755)
@@ -330,7 +330,7 @@ To run the python test suite:
330330

331331
## Usage Statistics (Telemetry)
332332

333-
Support for academic software is dependant on evidence of impact. Without evidence it is difficult/impossible to justify investment to add features and provide maintenance. We collect a minimal amount of anonymous usage data so that we can gather usage statistics that enable us to continue to develop the software under a free and permissible licence.
333+
Support for academic software is dependant on evidence of impact. Without evidence it is difficult/impossible to justify investment to add features and provide maintenance. We collect a minimal amount of anonymous usage data so that we can gather usage statistics that enable us to continue to develop the software under a free and permissible license.
334334

335335
Information is collected when a simulation, ensemble or test suite run have completed.
336336

@@ -367,7 +367,10 @@ Alternatively, [CITATION.cff](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/
367367
368368
## License
369369
370-
FLAME GPU is distributed under the [MIT Licence](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md).
370+
FLAME GPU is available under two licenses:
371+
372+
- [AGPL-3.0-only license](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md) for open source usage
373+
- A commercial licenses for cases where the use of the open source AGPL-licensed version is not possible or desirable. Please see [flamegpu.com/download/license/](https://flamegpu.com/download/license/) for more information.
371374
372375
## Known issues
373376

cmake/dependencies/flamegpu2-visualiser.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/modules/ ${CMAKE_MODULE_PATH})
66
include(FetchContent)
77

88
# Set the visualiser repo and tag to use unless overridden by the user.
9-
set(DEFAULT_FLAMEGPU_VISUALISATION_GIT_VERSION "9282bf46560976e932160e5ede6ce3b730111f20")
9+
set(DEFAULT_FLAMEGPU_VISUALISATION_GIT_VERSION "6d5fc2d55aa3f19353be3101ebddcf0e4aa64918")
1010
set(DEFAULT_FLAMEGPU_VISUALISATION_REPOSITORY "https://github.com/FLAMEGPU/FLAMEGPU2-visualiser.git")
1111

1212
# Set a VISUSLAITION_ROOT cache entry so it is available in the GUI to override the location if required

src/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ if (DEFINED ENV{FLAMEGPU_SHARE_USAGE_STATISTICS} AND NOT "$ENV{FLAMEGPU_SHARE_US
5151
set (FLAMEGPU_SHARE_USAGE_STATISTICS_DEFAULT OFF)
5252
endif()
5353
# Option to opt-in to sharing usage statistics
54-
option(FLAMEGPU_SHARE_USAGE_STATISTICS "Support for academic software is dependant on evidence of impact. Enabling this sends anonymous usage statistics so that we can continue to develop it under a free licence." ${FLAMEGPU_SHARE_USAGE_STATISTICS_DEFAULT})
54+
option(FLAMEGPU_SHARE_USAGE_STATISTICS "Support for academic software is dependant on evidence of impact. Enabling this sends anonymous usage statistics so that we can continue to develop it under a free license." ${FLAMEGPU_SHARE_USAGE_STATISTICS_DEFAULT})
5555
unset(FLAMEGPU_SHARE_USAGE_STATISTICS_DEFAULT)
5656

5757
# dependet option to suppress the telemetry notice if telemetry is off.
@@ -557,7 +557,7 @@ else()
557557
message(STATUS "FLAMEGPU_SHARE_USAGE_STATISTICS is not selected. \n\n"
558558
" Support for academic software is dependant on evidence of impact. \n"
559559
" Enabling this option sends minimal anonymous usage statistics so \n"
560-
" that we can continue to develop the software under a FOSS licence.\n"
560+
" that we can continue to develop the software under a FOSS license.\n"
561561
" See our documentation for more information of what we collect and \n"
562562
" why: https://docs.flamegpu.com/guide/telemetry")
563563
endif()

swig/python/setup.py.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ setup(
2828
'Development Status :: 3 - Alpha',
2929
'Environment :: GPU :: NVIDIA CUDA :: @CUDAToolkit_VERSION_MAJOR@.@CUDAToolkit_VERSION_MINOR@',
3030
'Intended Audience :: Developers',
31-
'License :: OSI Approved :: MIT License',
31+
'License :: OSI Approved :: GNU Affero General Public License v3',
3232
'Operating System :: POSIX :: Linux',
3333
'Operating System :: Microsoft :: Windows',
3434
'Programming Language :: Python',

0 commit comments

Comments
 (0)