Skip to content

Commit

Permalink
©️ Make source code compliant with the REUSE specification
Browse files Browse the repository at this point in the history
  • Loading branch information
Schneegans committed Oct 15, 2023
1 parent df99dd9 commit 4f84090
Show file tree
Hide file tree
Showing 10 changed files with 378 additions and 32 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/badges.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
# SPDX-License-Identifier: CC0-1.0

name: Build Badges

on: [push]
Expand Down
41 changes: 41 additions & 0 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Files: package.json package-lock.json node_modules/.package-lock.json
Copyright: Simon Schneegans <code@simonschneegans.de>
License: CC0-1.0

Files: node_modules/@actions/*
Copyright: GitHub
License: MIT

Files: node_modules/anafanafo/* node_modules/char-width-table-consumer/*
Copyright: Metabolize LLC
License: MIT

Files: node_modules/badge-maker/*
Copyright: Thaddée Tyl <thaddee.tyl@gmail.com>
License: CC0-1.0

Files: node_modules/binary-search/*
Copyright: The Dark Sky Company, LLC
License: CC0-1.0

Files: node_modules/color-convert/*
Copyright: Heather Arthur <fayearthur@gmail.com>
License: MIT

Files: node_modules/color-name/*
Copyright: DY <dfcreative@gmail.com>
License: MIT

Files: node_modules/css-color-converter/* node_modules/css-unit-converter/*
Copyright: Andy Jansson
License: MIT

Files: node_modules/tunnel/*
Copyright: Koichi Kobayashi
License: MIT

Files: node_modules/uuid/*
Copyright: Robert Kieffer and other contributors
License: MIT
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Simon Schneegans
Copyright (c) 2023 Simon Schneegans

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
156 changes: 156 additions & 0 deletions LICENSES/CC-BY-4.0.txt

Large diffs are not rendered by default.

121 changes: 121 additions & 0 deletions LICENSES/CC0-1.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
9 changes: 9 additions & 0 deletions LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
SPDX-License-Identifier: CC-BY-4.0
-->

# 🏷️ Dynamic Badges Action

[![badges](https://github.com/Schneegans/dynamic-badges-action/workflows/Build%20Badges/badge.svg)](https://github.com/Schneegans/dynamic-badges-action/actions)
Expand Down
63 changes: 33 additions & 30 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,80 +1,83 @@
name: 'Dynamic Badges'
description: 'Create badges via shields.io/endpoint for your README.md which may change with every commit.'
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
# SPDX-License-Identifier: MIT

name: "Dynamic Badges"
description: "Create badges via shields.io/endpoint for your README.md which may change with every commit."
branding:
icon: 'tag'
color: 'green'
icon: "tag"
color: "green"
inputs:
auth:
description: 'Your secret with the gist scope'
description: "Your secret with the gist scope"
required: true
gistID:
description: 'The ID of the gist to use'
description: "The ID of the gist to use"
required: true
filename:
description: 'The *.json or *.svg filename of the badge data'
description: "The *.json or *.svg filename of the badge data"
required: true
label:
description: 'The left text of the badge'
description: "The left text of the badge"
required: true
message:
description: 'The right text of the badge'
description: "The right text of the badge"
required: true
host:
description: 'The base URL of the gist API'
default: 'https://api.github.com/gists/'
description: "The base URL of the gist API"
default: "https://api.github.com/gists/"
required: false
forceUpdate:
description: 'If set to true, the gist will be updated even if the content did not change'
default: 'false'
description: "If set to true, the gist will be updated even if the content did not change"
default: "false"
required: false
labelColor:
description: 'The left color of the badge'
description: "The left color of the badge"
required: false
color:
description: 'The right color of the badge'
description: "The right color of the badge"
required: false
isError:
description: 'The color will be red and cannot be overridden'
description: "The color will be red and cannot be overridden"
required: false
namedLogo:
description: 'A logo name from simpleicons.org'
description: "A logo name from simpleicons.org"
required: false
logoSvg:
description: 'An svg-string to be used as logo'
description: "An svg-string to be used as logo"
required: false
logoColor:
description: 'The color for the logo'
description: "The color for the logo"
required: false
logoWidth:
description: 'The space allocated for the logo'
description: "The space allocated for the logo"
required: false
logoPosition:
description: 'The position of the logo'
description: "The position of the logo"
required: false
style:
description: 'The style like "flat" or "social"'
required: false
cacheSeconds:
description: 'The cache lifetime in seconds (must be greater than 300)'
description: "The cache lifetime in seconds (must be greater than 300)"
required: false
valColorRange:
description: 'A numerical value used to define the message color. Usually this should be between maxColorRange and minColorRange. This is required if you want to use the color range feature.'
description: "A numerical value used to define the message color. Usually this should be between maxColorRange and minColorRange. This is required if you want to use the color range feature."
required: false
maxColorRange:
description: 'If valColorRange assumes this value, the badge will be green. This is required if you want to use the color range feature.'
description: "If valColorRange assumes this value, the badge will be green. This is required if you want to use the color range feature."
required: false
minColorRange:
description: 'If valColorRange assumes this value, the badge will be red. This is required if you want to use the color range feature.'
description: "If valColorRange assumes this value, the badge will be red. This is required if you want to use the color range feature."
required: false
invertColorRange:
description: 'If the range should be inverted, causing a smaller value to have green color. Defaults to false.'
description: "If the range should be inverted, causing a smaller value to have green color. Defaults to false."
required: false
colorRangeSaturation:
description: 'Saturation used by the color range feature. Defaults to 100.'
description: "Saturation used by the color range feature. Defaults to 100."
required: false
colorRangeLightness:
description: 'Lightness used by the color range feature. Defaults to 40.'
description: "Lightness used by the color range feature. Defaults to 40."
required: false
runs:
using: 'node20'
main: 'index.js'
using: "node20"
main: "index.js"
6 changes: 6 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
SPDX-License-Identifier: CC-BY-4.0
-->

# Changelog of the Dynamic Badges Action

## [Dynamic Badges Action 1.7.0](https://github.com/Schneegans/dynamic-badges-action/tree/v1.7.0)
Expand All @@ -11,6 +16,7 @@
- Fixed a bug which caused the gist not to be updated if the label or message of the badge contained characters which have a different encoding length in UTF8 and UTF16,
- The code has received some major refactoring. If you encounter any problems, please open an issue!
- The action now runs on Node 20 instead of Node 16.
- The repository is now compliant with the [REUSE Specification](https://reuse.software/) of the Free Software Foundation Europe.

## [Dynamic Badges Action 1.6.0](https://github.com/Schneegans/dynamic-badges-action/tree/v1.6.0)

Expand Down
4 changes: 3 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
//////////////////////////////////////////////////////////////////////////////////////////
// This file is part of the Dynamic Badges Action //
// It may be used under the terms of the MIT license. See the LICENSE file for details. //
// Copyright: (c) 2020 Simon Schneegans //
//////////////////////////////////////////////////////////////////////////////////////////

// SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
// SPDX-License-Identifier: MIT

import core from "@actions/core";
import { makeBadge } from "badge-maker";

Expand Down

0 comments on commit 4f84090

Please sign in to comment.