Open Source #112

BigBlueHat · 2024-02-12T20:07:23Z

These changes effectively open source this project under the
BSD-3-Clause license.

Additionally it follows most of the REUSE v3.0 specification which outlines
how license claims can be made unambiguously for every file.

Happy to discuss the particulars!
🎩

Per REUSE v3.0 https://reuse.software/spec/#license-files

codecov · 2024-02-12T20:09:06Z

Codecov Report

Merging #112 (87d6b52) into main (e794160) will increase coverage by 0.23%.
The diff coverage is 100.00%.

❗ Current head 87d6b52 differs from pull request most recent head a66b5e5. Consider uploading reports for the commit a66b5e5 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #112      +/-   ##
==========================================
+ Coverage   80.00%   80.23%   +0.23%     
==========================================
  Files          10       10              
  Lines        1800     1821      +21     
==========================================
+ Hits         1440     1461      +21     
  Misses        360      360

Files	Coverage Δ
lib/config.js	`100.00% <100.00%> (ø)`
lib/configUtil.js	`100.00% <100.00%> (ø)`
lib/events.js	`78.57% <100.00%> (+1.64%)`	⬆️
lib/helpers.js	`71.42% <100.00%> (+1.05%)`	⬆️
lib/index.js	`68.81% <100.00%> (+0.08%)`	⬆️
lib/loggers/WorkerTransport.js	`89.58% <100.00%> (+0.45%)`	⬆️
lib/loggers/fileLogger.js	`80.39% <100.00%> (+0.39%)`	⬆️
lib/loggers/formatters.js	`66.01% <100.00%> (+0.67%)`	⬆️
lib/loggers/index.js	`89.42% <100.00%> (+0.10%)`	⬆️
lib/util.js	`94.17% <100.00%> (+0.11%)`	⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e794160...a66b5e5. Read the comment docs.

dlongley

Thanks! @davidlehn, this look right to you?

dlongley · 2024-02-12T20:09:07Z

lib/events.js

- * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2012-2024 Digital Bazaar, Inc.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause


Bummer that we need this in every file.

There is an alternative for spelling out copyright in a .reuse/dep5 file--which I've added for formats where comments are cumbersome/odd (Markdown uses HTML comments) or not available (.json): 45a2af2

The more explicit we are, the less confusion the could/would be when we include any outside contribution, file, or directory (which would contain it's own copyright info).

The wildcard approach of a single LICENSE file just isn't as clear.

lib/index.js

lib/util.js

lib/worker.js

test/test.js

dlongley · 2024-02-12T20:11:01Z

Oh, we need a changelog entry as well, with a minor release bump, I think. We could also bump the node version to 18+ while we're at it.

This includes explicit reference to each file which currently lack (or cannot themselves contain) a license comment preamble. This is primarily to avoid the addition of several `.license` files per licensable file.

BigBlueHat · 2024-02-12T20:24:16Z

Oh, we need a changelog entry as well, with a minor release bump, I think. We could also bump the node version to 18+ while we're at it.

Do you want those Node version bumps (in package.json and the workflow) done in a separate PR?

The workflow actions also need version bumps...

BigBlueHat · 2024-02-12T20:27:02Z

This PR properly licenses every file in this repo (per the RESUE standard as examined by the reuse tool:

# SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: 0
* Unused licenses: 0
* Used licenses: BSD-3-Clause
* Read errors: 0
* files with copyright information: 29 / 29
* files with license information: 29 / 29

Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)

dlongley · 2024-02-12T20:52:36Z

Oh, we need a changelog entry as well, with a minor release bump, I think. We could also bump the node version to 18+ while we're at it.

Do you want those Node version bumps (in package.json and the workflow) done in a separate PR?

The workflow actions also need version bumps...

They can be done here, that's fine -- another PR is also fine, your call.

dlongley · 2024-02-12T21:19:20Z

We still need a CHANGELOG entry here with the license update -- and the README mentions the license in it ... that might need an update.

BigBlueHat · 2024-02-12T21:28:56Z

We still need a CHANGELOG entry here with the license update -- and the README mentions the license in it ... that might need an update.

My bad! I'd thought I'd committed and pushed that...but wandered off to do the node stuff. Sorry about that.

dlongley

See couple of suggestions and then we're good.

dlongley · 2024-02-12T22:06:27Z

LICENSE-bedrock.md

+Bedrock Non-Commercial License v1.0
+===================================
+
+Copyright (c) 2011-2021 Digital Bazaar, Inc.


Suggested change

Copyright (c) 2011-2021 Digital Bazaar, Inc.

Copyright (c) 2011-2024 Digital Bazaar, Inc.

dlongley · 2024-02-12T22:07:10Z

package.json

@@ -43,7 +43,7 @@
    "jsdoc-to-markdown": "^7.1.1"
  },
  "engines": {
-    "node": ">=14"
+    "node": ">=20"


18 is still being maintained so we can include that here.

Suggested change

"node": ">=20"

"node": ">=18"

dlongley · 2024-02-12T22:07:51Z

CHANGELOG.md

@@ -2,6 +2,7 @@

 ## 6.0.2 - xxxx-xx-xx
 - Open Source under BSD-3-Clause license.
+- Bump Node.js versions to 20.x (current LTS).


Suggested change

- Bump Node.js versions to 20.x (current LTS).

- Bump Node.js versions to 18.x (LTS).

BigBlueHat added 4 commits February 12, 2024 14:28

Ignore package-lock.json.

fae3061

Open source under BSD-3-Clause.

fe7fdb1

Add preamble to workflow & eslint config.

8eae595

Add raw BSD-3-Clause to LICENSES/ dir.

577ac56

Per REUSE v3.0 https://reuse.software/spec/#license-files

dlongley approved these changes Feb 12, 2024

View reviewed changes

dlongley requested a review from davidlehn February 12, 2024 20:10

Add .reuse/dep5 for full REUSE compliance.

45a2af2

This includes explicit reference to each file which currently lack (or cannot themselves contain) a license comment preamble. This is primarily to avoid the addition of several `.license` files per licensable file.

BigBlueHat marked this pull request as ready for review February 12, 2024 20:16

Fix copyright year on some files.

2d46cbe

Add CHANGELOG entry.

87d6b52

BigBlueHat added 3 commits February 12, 2024 16:31

Bump node versions to 20.x (latest LTS).

0b99323

Remove old broken reference to the Bedrock logo.

39105c9

Clarify Bedrock licensing scenario.

a96b6fc

dlongley approved these changes Feb 12, 2024

View reviewed changes

Correct Node LTS version use.

a66b5e5

dlongley merged commit a956b81 into main Feb 12, 2024
3 of 4 checks passed

dlongley deleted the open-source branch February 12, 2024 22:23

dlongley mentioned this pull request Feb 12, 2024

Update workflow. #110

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open Source #112

Open Source #112

BigBlueHat commented Feb 12, 2024

codecov bot commented Feb 12, 2024 •

edited

Loading

dlongley left a comment

dlongley Feb 12, 2024

BigBlueHat Feb 12, 2024

dlongley commented Feb 12, 2024

BigBlueHat commented Feb 12, 2024 •

edited

Loading

BigBlueHat commented Feb 12, 2024

dlongley commented Feb 12, 2024

dlongley commented Feb 12, 2024

BigBlueHat commented Feb 12, 2024

dlongley left a comment

dlongley Feb 12, 2024

dlongley Feb 12, 2024

dlongley Feb 12, 2024

	Copyright (c) 2011-2021 Digital Bazaar, Inc.
	Copyright (c) 2011-2024 Digital Bazaar, Inc.

	- Bump Node.js versions to 20.x (current LTS).
	- Bump Node.js versions to 18.x (LTS).

Open Source #112

Open Source #112

Conversation

BigBlueHat commented Feb 12, 2024

codecov bot commented Feb 12, 2024 • edited Loading

Codecov Report

dlongley left a comment

Choose a reason for hiding this comment

dlongley Feb 12, 2024

Choose a reason for hiding this comment

BigBlueHat Feb 12, 2024

Choose a reason for hiding this comment

dlongley commented Feb 12, 2024

BigBlueHat commented Feb 12, 2024 • edited Loading

BigBlueHat commented Feb 12, 2024

dlongley commented Feb 12, 2024

dlongley commented Feb 12, 2024

BigBlueHat commented Feb 12, 2024

dlongley left a comment

Choose a reason for hiding this comment

dlongley Feb 12, 2024

Choose a reason for hiding this comment

dlongley Feb 12, 2024

Choose a reason for hiding this comment

dlongley Feb 12, 2024

Choose a reason for hiding this comment

codecov bot commented Feb 12, 2024 •

edited

Loading

BigBlueHat commented Feb 12, 2024 •

edited

Loading