Use Reuse for the license #422

olamidepeterojo · 2024-12-12T14:34:27Z

Fixes #383

abompard · 2024-12-17T09:56:20Z

fedora_messaging/__init__.py

-# 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.
+/*


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

My apologies, i will amend it.

abompard · 2024-12-17T09:59:00Z

fedora_messaging/__init__.py

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


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

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?

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.

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

abompard

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

abompard · 2024-12-19T13:35:45Z

docs/sample_schema_package/mailman_messages/__init__.py

@@ -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


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.

abompard

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

tox.ini

abompard · 2025-01-02T14:57:47Z

tests/integration/test_cli.py

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


You can drop this line as well.

abompard · 2025-01-02T15:04:46Z

tests/fixtures/wrong_json_msg_dump.txt

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


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.

abompard · 2025-01-02T15:05:30Z

pyproject.toml

 [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+"


Please don't change the license.

abompard · 2025-01-02T15:07:53Z

pyproject.toml

@@ -1,11 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc
+#
+# SPDX-License-Identifier: GPL-2.0-or-later


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"

abompard · 2025-01-02T15:11:05Z

fedora_messaging/twisted/consumer.py

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


This can be dropped as well.

abompard · 2025-01-02T15:12:36Z

docs/schema-packages.txt

+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later


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

devel/run-liccheck.sh

abompard · 2025-01-02T15:15:43Z

configs/cacert.pem.license

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


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"

abompard · 2025-01-02T15:20:17Z

.fmf/version

@@ -1 +1,4 @@
+SPDX-FileCopyrightText: 2024 Red Hat, Inc


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 · 2025-01-07T22:52:36Z

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 · 2025-01-08T13:02:14Z

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 · 2025-01-08T19:20:22Z

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

abompard

Some duplication between inline changes and REUSE.toml, and a couple comments about usage of wildcards.

abompard · 2025-02-14T15:21:55Z

REUSE.toml

+[[annotations]]
+path = ["tests/fixtures/bad_cb"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/ca_bundle.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/cert.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/good_msg_dump.txt"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/invalid_ca.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/invalid_key.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/invalid_msg_dump.txt"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/key.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/msg_without_topic_dump.txt"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/wrong_json_msg_dump.txt"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/ca_bundle.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/cert.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["tests/fixtures/key.pem"]


You could actually use a wildcard here: tests/fixtures/*. This will make the file much more readable.

abompard · 2025-02-14T15:22:33Z

CODEOWNERS

+# SPDX-FileCopyrightText: 2024 Red Hat, Inc
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+


You no longer need this since you have flagged this file in REUSE.toml.

abompard · 2025-02-14T15:23:11Z

LICENSE

@@ -1,339 +1,205 @@
                    GNU GENERAL PUBLIC LICENSE
                       Version 2, June 1991

- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,


You can actually delete this file, it's replaced by the one in the LICENSES directory.

abompard · 2025-02-14T15:24:13Z

poetry.lock.license

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


You don't need this file since you flagged poetry.lock in REUSE.toml.

abompard · 2025-02-14T15:25:52Z

REUSE.toml

+path = ["configs/cacert.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora-cert.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora-key.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora.stg-cert.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora.stg-key.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/stg-cacert.pem.license"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/cacert.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora-cert.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora-key.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora.stg-cert.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/fedora.stg-key.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"
+
+[[annotations]]
+path = ["configs/stg-cacert.pem"]
+SPDX-FileCopyrightText = "2024 Red Hat, Inc"
+SPDX-License-Identifier = "GPL-2.0-or-later"


You can use a wildcard in the path here as well: configs/*

abompard · 2025-02-14T15:28:40Z

codecov.yml

+# SPDX-FileCopyrightText: 2024 Red Hat, Inc
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+


You don't need this since you flagged the file in REUSE.toml.

abompard · 2025-02-14T15:31:03Z

packit/installation/main.fmf

@@ -1,3 +1,6 @@
+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later
+


Now that you've added it to REUSE.toml, you can drop this change.

abompard · 2025-02-14T15:31:47Z

tests/fixtures/bad_conf.toml

+# SPDX-FileCopyrightText: 2024 Red Hat, Inc
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+


The files in this directory have been added to REUSE.toml, no need for these changes anymore.

abompard

You can remove the files in configs/*.license and tests/fixtures/*.license now, since the corresponding files are now covered in REUSE.toml.

abompard · 2025-02-19T11:32:53Z

.pre-commit-config.yaml

@@ -24,7 +28,7 @@ repos:
  # Ruff
  - repo: https://github.com/charliermarsh/ruff-pre-commit
    # Ruff version.
-    rev: v0.8.6
+    rev: v0.8.2


This does not seem necessary, maybe a rebase fallout.

abompard · 2025-02-19T11:33:38Z

news/383.docs.md

@@ -0,0 +1,7 @@
+<!--


This comment is still current.

abompard · 2025-02-19T11:34:24Z

tests/fixtures/msg_without_topic_dump.txt

@@ -1 +1,2 @@
+


I don't think you need to add an empty line here.

abompard

You can also remove the news/*.license files as they are covered by REUSE.toml.

abompard · 2025-02-20T08:28:07Z

.packit.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc


This file is already covered by the .*.yaml glob in REUSE.toml.

abompard · 2025-02-20T08:28:22Z

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc


This file is already covered by the .*.yaml glob in REUSE.toml.

abompard · 2025-02-20T08:28:38Z

.readthedocs.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc


This file is already covered by the .*.yml glob in REUSE.toml.

abompard · 2025-02-20T08:29:25Z

configs/fedora.stg.toml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc


This file is already covered by the configs/* glob in REUSE.toml.

abompard · 2025-02-20T08:29:31Z

configs/fedora.toml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Red Hat, Inc


This file is already covered by the configs/* glob in REUSE.toml.

abompard · 2025-02-20T08:33:12Z

[email protected]

+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later


This requires a prefix comment. Systemd unit files are INI files, and therefore can use ; or # as a comment prefix. I would go for # since that's what I see most of the files in /usr/lib/systemd/system using.

Suggested change

SPDX-FileCopyrightText: 2024 Red Hat, Inc

SPDX-License-Identifier: GPL-2.0-or-later

# SPDX-FileCopyrightText: 2024 Red Hat, Inc

# SPDX-License-Identifier: GPL-2.0-or-later

abompard · 2025-02-20T12:41:08Z

config.toml.example

+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later


This requires a comment as well.

Suggested change

SPDX-FileCopyrightText: 2024 Red Hat, Inc

SPDX-License-Identifier: GPL-2.0-or-later

# SPDX-FileCopyrightText: 2024 Red Hat, Inc

# SPDX-License-Identifier: GPL-2.0-or-later

abompard · 2025-02-20T12:42:05Z

docs/requirements-readthedocs.txt

+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later


These lines must be commented out.

Suggested change

SPDX-FileCopyrightText: 2024 Red Hat, Inc

SPDX-License-Identifier: GPL-2.0-or-later

# SPDX-FileCopyrightText: 2024 Red Hat, Inc

# SPDX-License-Identifier: GPL-2.0-or-later

abompard · 2025-02-20T12:43:55Z

docs/sample_schema_package/README

+SPDX-FileCopyrightText: 2024 Red Hat, Inc
+SPDX-License-Identifier: GPL-2.0-or-later
+


This should be commented out but it's a plain text file. Maybe rename this file to .md and add the tags in a comment, as for SECURITY.md.

abompard

Looks good, thanks!
Could you please squash your 3 commits into one? Then it'll be good to merge.

…v0.8.6 (fedora-infra#428) Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Use Reuse for license Signed-off-by: Olamide Ojo <[email protected]>

Signed-off-by: Olamide Ojo <[email protected]>

abompard requested changes Dec 17, 2024

View reviewed changes

olamidepeterojo force-pushed the license branch from fc26af7 to 6849d35 Compare December 18, 2024 11:57

olamidepeterojo requested a review from abompard December 18, 2024 11:58

abompard requested changes Dec 19, 2024

View reviewed changes

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

olamidepeterojo requested a review from abompard December 21, 2024 15:57

abompard requested changes Jan 2, 2025

View reviewed changes

olamidepeterojo force-pushed the license branch from ec2069c to f295e35 Compare January 8, 2025 19:42

olamidepeterojo requested a review from abompard January 8, 2025 19:44

abompard requested changes Feb 14, 2025

View reviewed changes

olamidepeterojo requested a review from abompard February 16, 2025 11:22

abompard requested changes Feb 18, 2025

View reviewed changes

olamidepeterojo force-pushed the license branch from 8de426f to 6321105 Compare February 18, 2025 10:39

olamidepeterojo requested a review from abompard February 18, 2025 10:41

abompard requested changes Feb 19, 2025

View reviewed changes

olamidepeterojo force-pushed the license branch from 6321105 to 0816fbf Compare February 19, 2025 16:17

olamidepeterojo requested a review from abompard February 19, 2025 16:20

abompard requested changes Feb 20, 2025

View reviewed changes

olamidepeterojo force-pushed the license branch from 0816fbf to c1d1ae4 Compare February 20, 2025 11:54

olamidepeterojo requested a review from abompard February 20, 2025 11:54

abompard requested changes Feb 20, 2025

View reviewed changes

olamidepeterojo force-pushed the license branch from c1d1ae4 to 3479ca5 Compare February 20, 2025 21:50

olamidepeterojo requested a review from abompard February 20, 2025 21:51

abompard reviewed Feb 21, 2025

View reviewed changes

renovate bot and others added 2 commits February 21, 2025 22:24

Use Reuse as license

44ddeb2

Signed-off-by: Olamide Ojo <[email protected]>

olamidepeterojo force-pushed the license branch from 3479ca5 to 44ddeb2 Compare February 21, 2025 21:27

olamidepeterojo requested a review from abompard February 21, 2025 21:41

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

		@@ -1 +1,4 @@
		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.

		@@ -1,3 +1,6 @@
		SPDX-FileCopyrightText: 2024 Red Hat, Inc
		SPDX-License-Identifier: GPL-2.0-or-later

Use Reuse for the license #422

Are you sure you want to change the base?

Use Reuse for the license #422

Conversation

olamidepeterojo commented Dec 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olamidepeterojo Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abompard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abompard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olamidepeterojo commented Jan 7, 2025

abompard commented Jan 8, 2025

olamidepeterojo commented Jan 8, 2025

abompard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abompard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abompard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abompard left a comment

Choose a reason for hiding this comment

olamidepeterojo Dec 17, 2024 •

edited

Loading