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

Use Reuse for the license #422

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

olamidepeterojo
Copy link

Fixes #383

# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
/*
Copy link
Member

Choose a reason for hiding this comment

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

This is C/Javascript-style comments. In Python comments start with a #.

Copy link
Author

Choose a reason for hiding this comment

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

My apologies, i will amend it.

/*
* SPDX-FileCopyrightText: 2024 Red Hat, Inc
*
* SPDX-License-Identifier: GPL-3.0-or-later
Copy link
Member

Choose a reason for hiding this comment

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

The license is actually GPL-2.0-or-later.

Copy link
Author

@olamidepeterojo olamidepeterojo Dec 17, 2024

Choose a reason for hiding this comment

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

okay, although someone asked what version of GPL you preferred and you said GPL-3.0-or-later, that's why i made use of it .
so which do you prefer i make use of?

Copy link
Member

Choose a reason for hiding this comment

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

Let's not change the license from what it was before, even though I would prefer GPL-3.0-or-later, the code is currently under GPL-2.0-or-later.

Copy link
Author

Choose a reason for hiding this comment

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

Alright, I'll update it to GPL-2.0-or-later.

Copy link
Member

@abompard abompard left a comment

Choose a reason for hiding this comment

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

This PR is lacking the Reuse check itself. You can for example use this block in .pre-commit-config.yml :

  - repo: https://github.com/fsfe/reuse-tool
    rev: v5.0.2
    hooks:
      - id: reuse

@@ -2,7 +2,7 @@
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# the Free Software Foundation; either version 3 of the License, or
Copy link
Member

Choose a reason for hiding this comment

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

This is still changing the license. By the way, if you start using the SPDX-License-Identifier tag, you can drop this block of text.

@olamidepeterojo olamidepeterojo force-pushed the license branch 2 times, most recently from b5a591a to ec2069c Compare December 21, 2024 15:56
Copy link
Member

@abompard abompard left a comment

Choose a reason for hiding this comment

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

Some more comments, mostly related to using a REUSE.toml file.

@@ -1,3 +1,8 @@
; SPDX-FileCopyrightText: 2024 2024 Red Hat, Inc
; SPDX-FileCopyrightText: 2024 Red Hat, Inc
Copy link
Member

Choose a reason for hiding this comment

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

Those two lines seem redundant.

@@ -1,19 +1,8 @@
# This file is part of fedora_messaging.
# Copyright (C) 2019 Red Hat, Inc.
Copy link
Member

Choose a reason for hiding this comment

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

You can drop this line as well.

@@ -1 +1,4 @@
SPDX-FileCopyrightText: 2024 Red Hat, Inc
SPDX-License-Identifier: GPL-2.0-or-later
Copy link
Member

Choose a reason for hiding this comment

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

This does not make sense for a test fixture, I would add the fixtures to a block in a REUSE.toml file, using a wildcard, such as:

# Test fixtures
[[annotations]]
path = ["tests/fixtures/*"]
SPDX-FileCopyrightText = "2024 Red Hat, Inc"
SPDX-License-Identifier = "GPL-2.0-or-later"

This applies to all the files in this directory.

pyproject.toml Outdated
[tool.poetry]
name = "fedora_messaging"
version = "3.6.0"
description = "A set of tools for using Fedora's messaging infrastructure"
authors = [
"Fedora Infrastructure <[email protected]>"
]
license = "GPLv2+"
license = "GPLv3+"
Copy link
Member

Choose a reason for hiding this comment

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

Please don't change the license.

pyproject.toml Outdated
@@ -1,11 +1,15 @@
# SPDX-FileCopyrightText: 2024 Red Hat, Inc
#
# SPDX-License-Identifier: GPL-2.0-or-later
Copy link
Member

Choose a reason for hiding this comment

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

It does not make much sense in the case of this file, because we're talking about project configuration here.
I would add these files to a block in a REUSE.toml file, such as:

# Project configuration
[[annotations]]
path = ["pyproject.toml", "poetry.lock", "codecov.yml", ".*.yml", ".*.yaml", "CODEOWNERS"]
SPDX-FileCopyrightText = "2024 Red Hat, Inc"
SPDX-License-Identifier = "GPL-2.0-or-later"

@@ -1,20 +1,7 @@
# This file is part of fedora_messaging.
# Copyright (C) 2019 Red Hat, Inc.
Copy link
Member

Choose a reason for hiding this comment

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

This can be dropped as well.

Comment on lines 1 to 2
SPDX-FileCopyrightText: 2024 Red Hat, Inc
SPDX-License-Identifier: GPL-2.0-or-later
Copy link
Member

Choose a reason for hiding this comment

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

Please add the hash sign at the beginning of those lines to mark them as comments.

@@ -1,9 +1,6 @@
#!/bin/bash
Copy link
Member

Choose a reason for hiding this comment

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

Please leave this line in place.

@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2024 Red Hat, Inc
Copy link
Member

Choose a reason for hiding this comment

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

All the files in configs can also be covered by a block in a REUSE.toml file, such as:

# configs
[[annotations]]
path = ["configs/*"]
SPDX-FileCopyrightText = "2024 Red Hat, Inc"
SPDX-License-Identifier = "GPL-2.0-or-later"

.fmf/version Outdated
@@ -1 +1,4 @@
SPDX-FileCopyrightText: 2024 Red Hat, Inc
Copy link
Member

Choose a reason for hiding this comment

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

The FMF config files can be covered by a block in a REUSE.toml file, such as:

# FMF
[[annotations]]
path = [".fmf/version", "packit/installation/*.fmf"]
SPDX-FileCopyrightText = "2024 Red Hat, Inc"
SPDX-License-Identifier = "GPL-2.0-or-later"

@olamidepeterojo
Copy link
Author

hello, i've made the changes as requested but when i run reuse lint it fails saying the following files listed below do not have license

  • configs\cacert.pem
  • configs\fedora-cert.pem
  • configs\fedora-key.pem
  • configs\fedora.stg-cert.pem
  • configs\fedora.stg-key.pem
  • configs\stg-cacert.pem
  • tests\fixtures\ca_bundle.pem
  • tests\fixtures\cert.pem
  • tests\fixtures\key.pem

@abompard
Copy link
Member

abompard commented Jan 8, 2025

Yes, you can use a REUSE.toml file to cover those files, as indicated in the comments. I don't see it, maybe you forgot to add it to the repo with git add?

@olamidepeterojo
Copy link
Author

I'm surprised as well. i thought i did cause usually i git add .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use Reuse for the license
2 participants