Automatically responding to accepted additions to the SPDX License List


Sebastian Crane
 

Dear all,

I have good news! I've been able to create a CI workflow which responds
to accepted license requests on GitHub automatically, letting everyone
know that the license won't be visible on the website until the next
release.

Attached is a screenshot from a test repository of mine, where I've
simulated opening, labelling as accepted, then closing a 'New License
Request' issue. To prevent it from running repeatedly, the workflow adds
a 'finalised' label which it checks for before commenting. Let me know
what you think of the wording and we can get this running for real!

Best wishes,

Sebastian


Jim Vitrano
 

Looks like a good message.  If there's a page that shows the schedule for the next release that we can point the submitter at, that might give submitters more of an idea of when to expect the release than a generic "sometime in the next three months."

One other suggestion is whether there's a better name for the new label than "finalised," when there's still a release step remaining before the process is fully final.  Maybe something like "acceptance notification sent" would be a better description, if a little wordier?

Thanks again, Sebastian!

- Jim

On 8/24/22 17:29, Sebastian Crane wrote:
Dear all,

I have good news! I've been able to create a CI workflow which responds
to accepted license requests on GitHub automatically, letting everyone
know that the license won't be visible on the website until the next
release.

Attached is a screenshot from a test repository of mine, where I've
simulated opening, labelling as accepted, then closing a 'New License
Request' issue. To prevent it from running repeatedly, the workflow adds
a 'finalised' label which it checks for before commenting. Let me know
what you think of the wording and we can get this running for real!

Best wishes,

Sebastian




Alexios Zavras
 

Nice automation work, Sebastian!

I'm probably missing something, but...
The review and the labeling as "accepted" is happening on the issue where someone submits a new license.
In order to have "the license's information added to the repository", we also need a PR with the license XML, test file, etc.

How is this handled?
I definitely remember cases in the past where licenses were accepted and then we had to wait a long time for a PR (or Steve usually went ahead and created one).

-- zvr

-----Original Message-----
From: Spdx-legal@... <Spdx-legal@...> On Behalf Of Sebastian Crane
Sent: Thursday, 25 August, 2022 00:30
To: SPDX Legal Mailing List <spdx-legal@...>
Subject: Automatically responding to accepted additions to the SPDX License List

Dear all,

I have good news! I've been able to create a CI workflow which responds to accepted license requests on GitHub automatically, letting everyone know that the license won't be visible on the website until the next release.

Attached is a screenshot from a test repository of mine, where I've simulated opening, labelling as accepted, then closing a 'New License Request' issue. To prevent it from running repeatedly, the workflow adds a 'finalised' label which it checks for before commenting. Let me know what you think of the wording and we can get this running for real!

Best wishes,

Sebastian





Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928


Steve Winslow
 

Sebastian, this is awesome!

I did have the same reaction as Alexios. I think we'll want to tweak the wording, to clarify the process -- e.g. that we've approved it to add, but that it'll still need the XML and test text file to be added. We could probably even point them to documentation about how to contribute those files themselves, and clarify that they can do so or else it'll be subject to whether / when another community member chooses to add them.

So we can figure out the right wording to use -- but I really like this as an added piece of automation and I think it'll help with communication around the process. Thanks for putting this together!

Steve

On Thu, Aug 25, 2022 at 2:57 AM Alexios Zavras <alexios.zavras@...> wrote:
Nice automation work, Sebastian!

I'm probably missing something, but...
The review and the labeling as "accepted" is happening on the issue where someone submits a new license.
In order to have "the license's information added to the repository", we also need a PR with the license XML, test file, etc.

How is this handled?
I definitely remember cases in the past where licenses were accepted and then we had to wait a long time for a PR (or Steve usually went ahead and created one).

-- zvr

-----Original Message-----
From: Spdx-legal@... <Spdx-legal@...> On Behalf Of Sebastian Crane
Sent: Thursday, 25 August, 2022 00:30
To: SPDX Legal Mailing List <spdx-legal@...>
Subject: Automatically responding to accepted additions to the SPDX License List

Dear all,

I have good news! I've been able to create a CI workflow which responds to accepted license requests on GitHub automatically, letting everyone know that the license won't be visible on the website until the next release.

Attached is a screenshot from a test repository of mine, where I've simulated opening, labelling as accepted, then closing a 'New License Request' issue. To prevent it from running repeatedly, the workflow adds a 'finalised' label which it checks for before commenting. Let me know what you think of the wording and we can get this running for real!

Best wishes,

Sebastian





Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva 
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928







Sebastian Crane
 

Dear Alexios,

Thanks for your feedback! My understanding of the new license addition
process was that the issue where the addition was requested would only
be closed after the associated PR was merged (which would happen
automatically if the PR author wrote "Resolves issue #xxx" in the PR
description). As such, my automation would only respond to closed
issues.

The whole process would be:

1: user creates an issue requesting the license addition
2: it's labelled as either accepted or declined
3: if it's accepted, a PR is created by someone
4: after PR is merged, the issue is closed
5: the script would automatically comment

Hope this explains it; let me know if I forgot something!

Best wishes,

Sebastian

On Thu, Aug 25, 2022 at 06:56:58AM +0000, Alexios Zavras wrote:
Nice automation work, Sebastian!

I'm probably missing something, but...
The review and the labeling as "accepted" is happening on the issue where someone submits a new license.
In order to have "the license's information added to the repository", we also need a PR with the license XML, test file, etc.

How is this handled?
I definitely remember cases in the past where licenses were accepted and then we had to wait a long time for a PR (or Steve usually went ahead and created one).

-- zvr

-----Original Message-----
From: Spdx-legal@... <Spdx-legal@...> On Behalf Of Sebastian Crane
Sent: Thursday, 25 August, 2022 00:30
To: SPDX Legal Mailing List <spdx-legal@...>
Subject: Automatically responding to accepted additions to the SPDX License List

Dear all,

I have good news! I've been able to create a CI workflow which responds to accepted license requests on GitHub automatically, letting everyone know that the license won't be visible on the website until the next release.

Attached is a screenshot from a test repository of mine, where I've simulated opening, labelling as accepted, then closing a 'New License Request' issue. To prevent it from running repeatedly, the workflow adds a 'finalised' label which it checks for before commenting. Let me know what you think of the wording and we can get this running for real!

Best wishes,

Sebastian





Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928






J Lovejoy
 

Hi Sebastian,

Ah, so the script would run and thus, the message appear when the issue is close (not when the 'accepted' label is added). This comment would essentially be like manually making a "comment and close" comment on an issue?

That means this would also come after the decision is logged manually using our new-ish decision template, is that right?

Thanks,
Jilayne

On 8/25/22 9:44 AM, Sebastian Crane wrote:

Dear Alexios,

Thanks for your feedback! My understanding of the new license addition
process was that the issue where the addition was requested would only
be closed after the associated PR was merged (which would happen
automatically if the PR author wrote "Resolves issue #xxx" in the PR
description). As such, my automation would only respond to closed
issues.

The whole process would be:

1: user creates an issue requesting the license addition
2: it's labelled as either accepted or declined
3: if it's accepted, a PR is created by someone
4: after PR is merged, the issue is closed
5: the script would automatically comment

Hope this explains it; let me know if I forgot something!

Best wishes,

Sebastian

On Thu, Aug 25, 2022 at 06:56:58AM +0000, Alexios Zavras wrote:
Nice automation work, Sebastian!

I'm probably missing something, but...
The review and the labeling as "accepted" is happening on the issue where someone submits a new license.
In order to have "the license's information added to the repository", we also need a PR with the license XML, test file, etc.

How is this handled?
I definitely remember cases in the past where licenses were accepted and then we had to wait a long time for a PR (or Steve usually went ahead and created one).

-- zvr

-----Original Message-----
From: Spdx-legal@... <Spdx-legal@...> On Behalf Of Sebastian Crane
Sent: Thursday, 25 August, 2022 00:30
To: SPDX Legal Mailing List <spdx-legal@...>
Subject: Automatically responding to accepted additions to the SPDX License List

Dear all,

I have good news! I've been able to create a CI workflow which responds to accepted license requests on GitHub automatically, letting everyone know that the license won't be visible on the website until the next release.

Attached is a screenshot from a test repository of mine, where I've simulated opening, labelling as accepted, then closing a 'New License Request' issue. To prevent it from running repeatedly, the workflow adds a 'finalised' label which it checks for before commenting. Let me know what you think of the wording and we can get this running for real!

Best wishes,

Sebastian





Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928