Skip to content
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

Add missing licenses to CI artifacts and include licenses in all builds #301

Merged
merged 2 commits into from
May 20, 2024

Conversation

Jayman2000
Copy link
Contributor

Pull Request Type

  • GitHub Workflow changes
  • Documentation or Wiki changes
  • Build and Dependency changes
  • Runtime changes
    • Render changes
    • Audio changes
    • Input changes
    • Network changes
    • Other changes

Description

This PR makes sure that previously missing licenses are included in CI artifacts. It also makes sure that licenses get bundled with every build, even if you don’t use CI to do that build.

Related Issues

Fixes #295.

Checklist

  • I have tested my changes locally and verified that they work as intended.
  • I have documented any new or modified functionality.
  • I have reviewed the changes to ensure they do not introduce any unnecessary complexity or duplicate code.
  • I understand that by submitting this pull request, I am agreeing to license my contributions under the project's license.

Additional Comments

@JeodC
Copy link
Collaborator

JeodC commented May 7, 2024

We should use a different md5 library that is more friendly.

@Lgt2x
Copy link
Collaborator

Lgt2x commented May 7, 2024

I'd personnally like to keep the top-level LICENSE file as the full GPLv3 text

@Jayman2000
Copy link
Contributor Author

I'd personnally like to keep the top-level LICENSE file as the full GPLv3 text

Are you saying that you would prefer it if LICENSE wasn’t a symlink in the commit itself, or are you saying that you would prefer it if there was a LICENSE file in CI artifacts?

@JeodC
Copy link
Collaborator

JeodC commented May 7, 2024

I'd personnally like to keep the top-level LICENSE file as the full GPLv3 text

Are you saying that you would prefer it if LICENSE wasn’t a symlink in the commit itself, or are you saying that you would prefer it if there was a LICENSE file in CI artifacts?

He's saying GPL-3.txt should be at the root of the artifact.

@Jayman2000
Copy link
Contributor Author

I'd personnally like to keep the top-level LICENSE file as the full GPLv3 text

Are you saying that you would prefer it if LICENSE wasn’t a symlink in the commit itself, or are you saying that you would prefer it if there was a LICENSE file in CI artifacts?

He's saying GPL-3.txt should be at the root of the artifact.

OK, done.

Lgt2x
Lgt2x previously requested changes May 7, 2024
Third-party licenses/spdlog.txt Outdated Show resolved Hide resolved
Third-party licenses/spdlog.txt Outdated Show resolved Hide resolved
@Jayman2000 Jayman2000 force-pushed the missing-licenses branch 2 times, most recently from 0bbf949 to 9d418a9 Compare May 8, 2024 15:43
@JeodC JeodC added the workflow Modifications to the github workflows label May 8, 2024
third_party_licenses/md5.txt Outdated Show resolved Hide resolved
third_party_licenses/spdlog.txt Outdated Show resolved Hide resolved
Before this change, the CI script had a special step that would ensure
that CI artifacts contained a copy of Descent 3’s license. This change
replaces that special CI step with a CMake target.

The main motivation behind this change is to make it easier for people
to create packages for Descent 3. Before this change, if you wanted to
create a package for Descent 3, then you would have to manually ensure
that your package contained a copy of the GPL.
Specifically, this commit only adds copies of licenses if we are
required to do so. For example, this commit adds a copy of libacm’s
license because libacm’s license requires that we include copies of
libacm’s license with binary copies of libacm. This commit does not add
a copy of zlib’s license because zlib’s license doesn’t require us to do
so.

Fixes DescentDevelopers#295.
@JeodC JeodC requested a review from Lgt2x May 19, 2024 22:19
@JeodC JeodC dismissed Lgt2x’s stale review May 20, 2024 12:38

No longer valid

@JeodC JeodC merged commit 451381e into DescentDevelopers:main May 20, 2024
10 checks passed
@Jayman2000 Jayman2000 deleted the missing-licenses branch May 20, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
workflow Modifications to the github workflows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI artifacts lack licenses for libraries
3 participants