After the yanked 2.0.0 release, we're excited to announce our latest major
version packed with new features and improvements! We've expanded our file type
recognition, now including Fennel, CommonJS, Qt .pro, .pri, .qrc, .qss, .ui,
Textile, Visual Studio Code workspace, Application Resource Bundle, Svelte
components, AES encrypted files, Jakarta Server Page, Clang format, Browserslist
config, Prettier config and ignored files, Flutter pubspec.lock, .metadata,
Terraform and HCL, Typst and more.
We've also added the ability to detect SPDX snippet tags in files and introduced
additional license metadata for the Python package. A new --json flag has been
added to the lint command, marking the first step towards better integration
of REUSE output with other tools.
On the changes front, we've bumped the SPDX license list to v3.21 and made
significant updates to our Sphinx documentation. Please note that Python 3.6 and
3.7 support has been dropped in this release.
We've fixed several issues including automatic generation of Sphinx
documentation via readthedocs.io and a compatibility issue where reuse could not
be installed if gettext is not installed.
This update is all about making your experience better. Enjoy adding copyright
and licensing information to your code!
Added loglevel argument to pytest and skip one test if loglevel is too high
(#645).
--add-license-concluded, --creator-person, and --creator-organization
added to reuse spdx. (#623)
Additional license metadata for the Python package has been added. The actual
SPDX license expression remains the same: Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later. (#733)
reuse.SpdxInfo was renamed to reuse.ReuseInfo. It is now a (frozen)
dataclass instead of a namedtuple. This is only relevant if you're using reuse
as a library in Python. Other functions and methods were similarly renamed.
(#669)
Sphinx documentation: Switched from RTD theme to Furo. (#673, #716)
Removed dependency on setuptools' pkg_resources to determine the installed
version of reuse. (#724)
Project.reuse_info_of now returns a list of ReuseInfo objects instead of a
single one. This is because the source information is now stored alongside the
REUSE information. (#787)
Deprecated
Pending deprecation of aggregation of file sources. Presently, when copyright
and licensing information is defined both within e.g. the file itself and in
the DEP5 file, then the information is merged or aggregated for the purposes
of linting and BOM generation. In the future, this will no longer be the case
unless explicitly defined. The exact mechanism for this is not yet concrete,
but a PendingDeprecationWarning will be shown to the user to make them aware
of this. (#778)
Removed
Python 3.6 and 3.7 support has been dropped. (#673, #759)
Removed runtime and build time dependency on setuptools. (#724)
Fixed
Fixed automatic generation of Sphinx documentation via readthedocs.io by
adding a .readthedocs.yaml configuration file (#648)
Fixed a compatibility issue where reuse could not be installed (built) if
gettext is not installed. (#691)
Translations are available in Docker images. (#701)
Marked the /data directory in Docker containers as safe in Git, preventing
errors related to linting Git repositories. (#720)
Repaired error when using Galician translations. (#719)
This version was yanked because of an unanticipated workflow that we broke. The
breaking change is the fact that an order of precedence was defined for
copyright and licensing information sources. For instance, if a file contained
the SPDX-License-Identifier tag, and if that file was also (explicitly or
implicitly) covered by DEP5, then the information from the DEP5 setting would no
longer apply to that file.
While the intention of the breaking change was sound (don't mix information
sources; define a single source of truth), there were legitimate use-cases that
were broken as a result of this.
Apologies to everyone whose CI broke. We'll get this one right before long.
Releases to PyPI are no longer GPG-signed. Support for this is not present in
Poetry and not planned. (#600)
Dependency on requests removed; using urllib.request from the standard
library instead. (#600)
Fixed
Repair tests related to CVE-2022-39253 changes in upstream Git. New versions
of Git no longer allow git submodule add repository path where repository is
a file. A flag was added to explicitly allow this in the test framework.
(#619)
Sanitize xargs input in scripts documentation. (#525)
License identifiers in comments with symmetrical ASCII art frames are now
properly detected (#560)
Fixed an error where copyright statements contained within a multi-line
comment style on a single line could not be parsed (#593).
A major release! Do not worry, no breaking changes but a development team
(@carmenbianca, @floriansnow, @linozen, @mxmehl and @nicorikken) that is
confident enough to declare the REUSE helper tool stable, and a bunch of
long-awaited features!
Apart from smaller changes under the hood and typical maintenance tasks, the
main additions are new flags to the addheader subcommand that ease recursive
and automatic operations, the ability to ignore areas of a file that contain
strings that may falsely be detected as copyright or license statements, and the
option to merge copyright lines. The tool now also has better handling of some
edge cases with copyright and license identifiers.
Added the ability to ignore parts of a file when running reuse lint. Simply
add REUSE-IgnoreStart and REUSE-IgnoreEnd as comments and all lines
between the two will be ignored by the next run of reuse lint. (#463)
Added --skip-existing flag to addheader in order to skip files that
already contain SPDX information. This may be useful for only adding SPDX
information to newly created files. (#480)
Ignore all SPDX files with their typical formats and extensions. (#494)
Add support for merging copyright lines based on copyright statement,
transforming multiple lines with a single year into a single line with a
range. (#328)
Changed
Use setuptools instead of the deprecated distutils which will be removed
with Python 3.12. (#451)
addheader --explicit-license renamed to --force-dot-license. (#476)
Dockerfiles for reuse-tool are now in a separate subdirectory docker. (#499)
The copyright detection mechanism now silently accepts the following strings: Copyright(c) and Copyright(C). (#440)
Deprecated
Deprecated --explicit-license in favour of --force-dot-license. --explicit-license will remain useable (although undocumented) for the
foreseeable future. (#476)
Removed
JsxCommentStyle in favor of using CCommentStyle directly (see section Fixed). (#406)
Fixed
Better support for unary "+" operator in license identifiers. For example, if Apache-1.0+ appears as a declared license, it should not be identified as
missing, bad, or unused if LICENSES/Apache-1.0.txt exists. It is, however,
identified separately as a used license. (#123)
When addheader creates a .license file, that file now has a newline at the
end. (#477)
JSX (.jxs and .tsx) actually uses C comment syntax as JSX blocks never
stand at the beginning of the file where the licensing info needs to go.
(#406)
Configuration
📅Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕Ignore: Close this PR and you won't be reminded about this update again.
If you want to rebase/retry this PR, check this box
This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| [reuse](https://reuse.software/) ([source](https://github.com/fsfe/reuse-tool)) | dev-packages | major | `==0.14.0` -> `==2.1.0` |
---
### Release Notes
<details>
<summary>fsfe/reuse-tool (reuse)</summary>
### [`v2.1.0`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#210---2023-07-18)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v2.0.0...v2.1.0)
After the yanked 2.0.0 release, we're excited to announce our latest major
version packed with new features and improvements! We've expanded our file type
recognition, now including Fennel, CommonJS, Qt .pro, .pri, .qrc, .qss, .ui,
Textile, Visual Studio Code workspace, Application Resource Bundle, Svelte
components, AES encrypted files, Jakarta Server Page, Clang format, Browserslist
config, Prettier config and ignored files, Flutter pubspec.lock, .metadata,
Terraform and HCL, Typst and more.
We've also added the ability to detect SPDX snippet tags in files and introduced
additional license metadata for the Python package. A new `--json` flag has been
added to the `lint` command, marking the first step towards better integration
of REUSE output with other tools.
On the changes front, we've bumped the SPDX license list to v3.21 and made
significant updates to our Sphinx documentation. Please note that Python 3.6 and
3.7 support has been dropped in this release.
We've fixed several issues including automatic generation of Sphinx
documentation via readthedocs.io and a compatibility issue where reuse could not
be installed if gettext is not installed.
This update is all about making your experience better. Enjoy adding copyright
and licensing information to your code!
##### Added
- Detect SPDX snippet tags in files. ([#​699](https://github.com/fsfe/reuse-tool/issues/699))
- More file types are recognised:
- Fennel (`.fnl`) ([#​638](https://github.com/fsfe/reuse-tool/issues/638))
- CommonJS (`.cjs`) ([#​632](https://github.com/fsfe/reuse-tool/issues/632))
- Qt .pro (`.pro`) ([#​632](https://github.com/fsfe/reuse-tool/issues/632))
- Qt .pri (`.pri`) ([#​755](https://github.com/fsfe/reuse-tool/issues/755))
- Qt .qrc (`.qrc`) ([#​755](https://github.com/fsfe/reuse-tool/issues/755))
- Qt .qss(`.qss`) ([#​755](https://github.com/fsfe/reuse-tool/issues/755))
- Qt .ui (`.ui`) ([#​755](https://github.com/fsfe/reuse-tool/issues/755))
- Textile (`.textile`) ([#​712](https://github.com/fsfe/reuse-tool/issues/712))
- Visual Studio Code workspace (`.code-workspace`) ([#​747](https://github.com/fsfe/reuse-tool/issues/747))
- Application Resource Bundle (`.arb`) ([#​749](https://github.com/fsfe/reuse-tool/issues/749))
- Svelte components (`.svelte`)
- AES encrypted files (`.aes`) ([#​758](https://github.com/fsfe/reuse-tool/issues/758))
- Jakarte Server Page (`.jsp`) ([#​757](https://github.com/fsfe/reuse-tool/issues/757))
- Clang format (`.clang-format`) ([#​632](https://github.com/fsfe/reuse-tool/issues/632))
- Browserslist config (`.browserslist`)
- Prettier config (`.prettierrc`) and ignored files (`.prettierignore`)
- Flutter pubspec.lock (`pubspec.lock`) ([#​751](https://github.com/fsfe/reuse-tool/issues/751))
- Flutter .metadata (`.metadata`) ([#​751](https://github.com/fsfe/reuse-tool/issues/751))
- Terraform (`.tf`, `tfvars`) and HCL (`.hcl`). ([#​756](https://github.com/fsfe/reuse-tool/issues/756))
- Typst (`.typ`)
- Added loglevel argument to pytest and skip one test if loglevel is too high
([#​645](https://github.com/fsfe/reuse-tool/issues/645)).
- `--add-license-concluded`, `--creator-person`, and `--creator-organization`
added to `reuse spdx`. ([#​623](https://github.com/fsfe/reuse-tool/issues/623))
- Additional license metadata for the Python package has been added. The actual
SPDX license expression remains the same:
`Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later`. ([#​733](https://github.com/fsfe/reuse-tool/issues/733))
- Added `--contributor` option to `annotate`. ([#​669](https://github.com/fsfe/reuse-tool/issues/669))
- Added `--json` flag to `lint` command ([#​654](https://github.com/fsfe/reuse-tool/issues/654)).
- `reuse.ReuseInfo` now has `copy` and `union` methods. ([#​759](https://github.com/fsfe/reuse-tool/issues/759))
- `reuse.ReuseInfo` now stores information about the source from which the
information was gathered. ([#​654](https://github.com/fsfe/reuse-tool/issues/654), [#​787](https://github.com/fsfe/reuse-tool/issues/787))
- Added Ukrainian and Czech translations ([#​767](https://github.com/fsfe/reuse-tool/issues/767))
- Added `--suppress-deprecation` to hide (verbose) deprecation warnings. ([#​778](https://github.com/fsfe/reuse-tool/issues/778))
##### Changed
- Bumped SPDX license list to v3.20. ([#​692](https://github.com/fsfe/reuse-tool/issues/692))
- `reuse.SpdxInfo` was renamed to `reuse.ReuseInfo`. It is now a (frozen)
dataclass instead of a namedtuple. This is only relevant if you're using reuse
as a library in Python. Other functions and methods were similarly renamed.
([#​669](https://github.com/fsfe/reuse-tool/issues/669))
- Sphinx documentation: Switched from RTD theme to Furo. ([#​673](https://github.com/fsfe/reuse-tool/issues/673), [#​716](https://github.com/fsfe/reuse-tool/issues/716))
- Removed dependency on setuptools' `pkg_resources` to determine the installed
version of reuse. ([#​724](https://github.com/fsfe/reuse-tool/issues/724))
- Bumped SPDX license list to v3.21. ([#​763](https://github.com/fsfe/reuse-tool/issues/763))
- `Project.reuse_info_of` now returns a list of `ReuseInfo` objects instead of a
single one. This is because the source information is now stored alongside the
REUSE information. ([#​787](https://github.com/fsfe/reuse-tool/issues/787))
##### Deprecated
- Pending deprecation of aggregation of file sources. Presently, when copyright
and licensing information is defined both within e.g. the file itself and in
the DEP5 file, then the information is merged or aggregated for the purposes
of linting and BOM generation. In the future, this will no longer be the case
unless explicitly defined. The exact mechanism for this is not yet concrete,
but a `PendingDeprecationWarning` will be shown to the user to make them aware
of this. ([#​778](https://github.com/fsfe/reuse-tool/issues/778))
##### Removed
- Python 3.6 and 3.7 support has been dropped. ([#​673](https://github.com/fsfe/reuse-tool/issues/673), [#​759](https://github.com/fsfe/reuse-tool/issues/759))
- Removed runtime and build time dependency on `setuptools`. ([#​724](https://github.com/fsfe/reuse-tool/issues/724))
##### Fixed
- Fixed automatic generation of Sphinx documentation via readthedocs.io by
adding a `.readthedocs.yaml` configuration file ([#​648](https://github.com/fsfe/reuse-tool/issues/648))
- Fixed a compatibility issue where reuse could not be installed (built) if
gettext is not installed. ([#​691](https://github.com/fsfe/reuse-tool/issues/691))
- Translations are available in Docker images. ([#​701](https://github.com/fsfe/reuse-tool/issues/701))
- Marked the `/data` directory in Docker containers as safe in Git, preventing
errors related to linting Git repositories. ([#​720](https://github.com/fsfe/reuse-tool/issues/720))
- Repaired error when using Galician translations. ([#​719](https://github.com/fsfe/reuse-tool/issues/719))
##### Security
### [`v2.0.0`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#200---2023-06-21-YANKED)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v1.1.2...v2.0.0)
This version was yanked because of an unanticipated workflow that we broke. The
breaking change is the fact that an order of precedence was defined for
copyright and licensing information sources. For instance, if a file contained
the `SPDX-License-Identifier` tag, and if that file was also (explicitly or
implicitly) covered by DEP5, then the information from the DEP5 setting would no
longer apply to that file.
While the intention of the breaking change was sound (don't mix information
sources; define a single source of truth), there were legitimate use-cases that
were broken as a result of this.
Apologies to everyone whose CI broke. We'll get this one right before long.
### [`v1.1.2`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#112---2023-02-09)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v1.1.1...v1.1.2)
##### Fixed
- Note to maintainers: It is now possible/easier to use the `build` module to
build this module. Previously, there was a namespace conflict. ([#​640](https://github.com/fsfe/reuse-tool/issues/640))
### [`v1.1.1`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#111---2023-02-05)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v1.1.0...v1.1.1)
##### Fixed
- Don't include documentation files (e.g. `README.md`) in top-level (i.e.,
`site-packages/`). ([#​657](https://github.com/fsfe/reuse-tool/issues/657))
- Include documentation directory in sdist. ([#​657](https://github.com/fsfe/reuse-tool/issues/657))
### [`v1.1.0`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#110---2022-12-01)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v1.0.0...v1.1.0)
##### Added
- Added support for Python 3.11. ([#​603](https://github.com/fsfe/reuse-tool/issues/603))
- More file types are recognised:
- Kotlin script (`.kts`)
- Android Interface Definition Language (`.aidl`)
- Certificate files (`.pem`)
- Added comment styles:
- Apache Velocity Template (Extensions: `.vm`, `.vtl`) ([#​554](https://github.com/fsfe/reuse-tool/issues/554))
- XQuery comment style (Extensions: `.xq(l|m|y|uery|)`) ([#​610](https://github.com/fsfe/reuse-tool/issues/610))
- Some special endings are always stripped from copyright and licensing
statements ([#​602](https://github.com/fsfe/reuse-tool/issues/602)):
- `">` (and variations such as `'>`, `" >`, and `"/>`)
- `] ::`
##### Changed
- Removed `setup.py` and replaced it with a Poetry configuration. Maintainers
beware. ([#​600](https://github.com/fsfe/reuse-tool/issues/600))
- Updated PyPI development status to 'production/stable' ([#​381](https://github.com/fsfe/reuse-tool/issues/381))
- The pre-commit hook now passes `lint` as an overridable argument. ([#​574](https://github.com/fsfe/reuse-tool/issues/574))
- `addheader` has been renamed to `annotate`. The functionality remains the
same. ([#​550](https://github.com/fsfe/reuse-tool/issues/550))
- Bumped SPDX license list to v3.19.
##### Deprecated
- `addheader` has been deprecated. It still works, but is now undocumented.
([#​550](https://github.com/fsfe/reuse-tool/issues/550))
##### Removed
- `setup.py`. ([#​600](https://github.com/fsfe/reuse-tool/issues/600))
- Releases to PyPI are no longer GPG-signed. Support for this is not present in
Poetry and not planned. ([#​600](https://github.com/fsfe/reuse-tool/issues/600))
- Dependency on `requests` removed; using `urllib.request` from the standard
library instead. ([#​600](https://github.com/fsfe/reuse-tool/issues/600))
##### Fixed
- Repair tests related to CVE-2022-39253 changes in upstream Git. New versions
of Git no longer allow `git submodule add repository path` where repository is
a file. A flag was added to explicitly allow this in the test framework.
([#​619](https://github.com/fsfe/reuse-tool/issues/619))
- Sanitize xargs input in scripts documentation. ([#​525](https://github.com/fsfe/reuse-tool/issues/525))
- License identifiers in comments with symmetrical ASCII art frames are now
properly detected ([#​560](https://github.com/fsfe/reuse-tool/issues/560))
- Fixed an error where copyright statements contained within a multi-line
comment style on a single line could not be parsed ([#​593](https://github.com/fsfe/reuse-tool/issues/593)).
- In PHP files, add header after `<?php` ([#​543](https://github.com/fsfe/reuse-tool/issues/543)).
### [`v1.0.0`](https://github.com/fsfe/reuse-tool/blob/HEAD/CHANGELOG.md#100---2022-05-19)
[Compare Source](https://github.com/fsfe/reuse-tool/compare/v0.14.0...v1.0.0)
A major release! Do not worry, no breaking changes but a development team
([@​carmenbianca](https://github.com/carmenbianca), [@​floriansnow](https://github.com/floriansnow), [@​linozen](https://github.com/linozen), [@​mxmehl](https://github.com/mxmehl) and [@​nicorikken](https://github.com/nicorikken)) that is
confident enough to declare the REUSE helper tool stable, and a bunch of
long-awaited features!
Apart from smaller changes under the hood and typical maintenance tasks, the
main additions are new flags to the `addheader` subcommand that ease recursive
and automatic operations, the ability to ignore areas of a file that contain
strings that may falsely be detected as copyright or license statements, and the
option to merge copyright lines. The tool now also has better handling of some
edge cases with copyright and license identifiers.
We would like to thank the many contributors to this release, among them
[@​ajinkyapatil8190](https://github.com/ajinkyapatil8190), [@​aspiers](https://github.com/aspiers), [@​ferdnyc](https://github.com/ferdnyc), [@​Gri-ffin](https://github.com/Gri-ffin), [@​hexagonrecursion](https://github.com/hexagonrecursion), [@​hoijui](https://github.com/hoijui),
[@​Jakelyst](https://github.com/Jakelyst), [@​Liambeguin](https://github.com/Liambeguin), [@​rex4539](https://github.com/rex4539), [@​robinkrahl](https://github.com/robinkrahl), [@​rpavlik](https://github.com/rpavlik), [@​siiptuo](https://github.com/siiptuo), [@​thbde](https://github.com/thbde) and
[@​ventosus](https://github.com/ventosus).
##### Added
- Extend [tool documentation](https://reuse.readthedocs.io) with scripts to help
using this tool and automating some steps that are not built into the tool
itself. ([#​500](https://github.com/fsfe/reuse-tool/issues/500))
- Recommendations for installation/run methods: package managers and pipx ([#​457](https://github.com/fsfe/reuse-tool/issues/457))
- Docker images for AArch64 ([#​478](https://github.com/fsfe/reuse-tool/issues/478))
- Added the ability to ignore parts of a file when running `reuse lint`. Simply
add `REUSE-IgnoreStart` and `REUSE-IgnoreEnd` as comments and all lines
between the two will be ignored by the next run of `reuse lint`. ([#​463](https://github.com/fsfe/reuse-tool/issues/463))
- [Meson subprojects](https://mesonbuild.com/Subprojects.html) are now ignored
by default. ([#​496](https://github.com/fsfe/reuse-tool/issues/496))
- More file types are recognised:
- sbt build files (`.sbt`)
- Vimscript files (`.vim`)
- Added `--skip-existing` flag to `addheader` in order to skip files that
already contain SPDX information. This may be useful for only adding SPDX
information to newly created files. ([#​480](https://github.com/fsfe/reuse-tool/issues/480))
- Added `--recursive` flag to `addheader`. ([#​469](https://github.com/fsfe/reuse-tool/issues/469))
- Preserve shebang for more script files:
- V-Lang ([#​432](https://github.com/fsfe/reuse-tool/issues/432))
- Ignore all SPDX files with their typical formats and extensions. ([#​494](https://github.com/fsfe/reuse-tool/issues/494))
- Add support for merging copyright lines based on copyright statement,
transforming multiple lines with a single year into a single line with a
range. ([#​328](https://github.com/fsfe/reuse-tool/issues/328))
##### Changed
- Use `setuptools` instead of the deprecated `distutils` which will be removed
with Python 3.12. ([#​451](https://github.com/fsfe/reuse-tool/issues/451))
- `addheader --explicit-license` renamed to `--force-dot-license`. ([#​476](https://github.com/fsfe/reuse-tool/issues/476))
- Dockerfiles for reuse-tool are now in a separate subdirectory `docker`. ([#​499](https://github.com/fsfe/reuse-tool/issues/499))
- Updated SPDX license list to 3.17. ([#​513](https://github.com/fsfe/reuse-tool/issues/513))
- The copyright detection mechanism now silently accepts the following strings:
`Copyright(c)` and `Copyright(C)`. ([#​440](https://github.com/fsfe/reuse-tool/issues/440))
##### Deprecated
- Deprecated `--explicit-license` in favour of `--force-dot-license`.
`--explicit-license` will remain useable (although undocumented) for the
foreseeable future. ([#​476](https://github.com/fsfe/reuse-tool/issues/476))
##### Removed
- `JsxCommentStyle` in favor of using `CCommentStyle` directly (see section
`Fixed`). ([#​406](https://github.com/fsfe/reuse-tool/issues/406))
##### Fixed
- Better support for unary "+" operator in license identifiers. For example, if
`Apache-1.0+` appears as a declared license, it should not be identified as
missing, bad, or unused if `LICENSES/Apache-1.0.txt` exists. It is, however,
identified separately as a used license. ([#​123](https://github.com/fsfe/reuse-tool/issues/123))
- When `addheader` creates a `.license` file, that file now has a newline at the
end. ([#​477](https://github.com/fsfe/reuse-tool/issues/477))
- Cleaned up internal string manipulation. ([#​477](https://github.com/fsfe/reuse-tool/issues/477))
- JSX (`.jxs` and `.tsx`) actually uses C comment syntax as JSX blocks never
stand at the beginning of the file where the licensing info needs to go.
([#​406](https://github.com/fsfe/reuse-tool/issues/406))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box
---
This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
This PR contains the following updates:
==0.14.0->==2.1.0Release Notes
fsfe/reuse-tool (reuse)
v2.1.0Compare Source
After the yanked 2.0.0 release, we're excited to announce our latest major
version packed with new features and improvements! We've expanded our file type
recognition, now including Fennel, CommonJS, Qt .pro, .pri, .qrc, .qss, .ui,
Textile, Visual Studio Code workspace, Application Resource Bundle, Svelte
components, AES encrypted files, Jakarta Server Page, Clang format, Browserslist
config, Prettier config and ignored files, Flutter pubspec.lock, .metadata,
Terraform and HCL, Typst and more.
We've also added the ability to detect SPDX snippet tags in files and introduced
additional license metadata for the Python package. A new
--jsonflag has beenadded to the
lintcommand, marking the first step towards better integrationof REUSE output with other tools.
On the changes front, we've bumped the SPDX license list to v3.21 and made
significant updates to our Sphinx documentation. Please note that Python 3.6 and
3.7 support has been dropped in this release.
We've fixed several issues including automatic generation of Sphinx
documentation via readthedocs.io and a compatibility issue where reuse could not
be installed if gettext is not installed.
This update is all about making your experience better. Enjoy adding copyright
and licensing information to your code!
Added
.fnl) (#638).cjs) (#632).pro) (#632).pri) (#755).qrc) (#755).qss) (#755).ui) (#755).textile) (#712).code-workspace) (#747).arb) (#749).svelte).aes) (#758).jsp) (#757).clang-format) (#632).browserslist).prettierrc) and ignored files (.prettierignore)pubspec.lock) (#751).metadata) (#751).tf,tfvars) and HCL (.hcl). (#756).typ)(#645).
--add-license-concluded,--creator-person, and--creator-organizationadded to
reuse spdx. (#623)SPDX license expression remains the same:
Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0 AND GPL-3.0-or-later. (#733)--contributoroption toannotate. (#669)--jsonflag tolintcommand (#654).reuse.ReuseInfonow hascopyandunionmethods. (#759)reuse.ReuseInfonow stores information about the source from which theinformation was gathered. (#654, #787)
--suppress-deprecationto hide (verbose) deprecation warnings. (#778)Changed
reuse.SpdxInfowas renamed toreuse.ReuseInfo. It is now a (frozen)dataclass instead of a namedtuple. This is only relevant if you're using reuse
as a library in Python. Other functions and methods were similarly renamed.
(#669)
pkg_resourcesto determine the installedversion of reuse. (#724)
Project.reuse_info_ofnow returns a list ofReuseInfoobjects instead of asingle one. This is because the source information is now stored alongside the
REUSE information. (#787)
Deprecated
and licensing information is defined both within e.g. the file itself and in
the DEP5 file, then the information is merged or aggregated for the purposes
of linting and BOM generation. In the future, this will no longer be the case
unless explicitly defined. The exact mechanism for this is not yet concrete,
but a
PendingDeprecationWarningwill be shown to the user to make them awareof this. (#778)
Removed
setuptools. (#724)Fixed
adding a
.readthedocs.yamlconfiguration file (#648)gettext is not installed. (#691)
/datadirectory in Docker containers as safe in Git, preventingerrors related to linting Git repositories. (#720)
Security
v2.0.0Compare Source
This version was yanked because of an unanticipated workflow that we broke. The
breaking change is the fact that an order of precedence was defined for
copyright and licensing information sources. For instance, if a file contained
the
SPDX-License-Identifiertag, and if that file was also (explicitly orimplicitly) covered by DEP5, then the information from the DEP5 setting would no
longer apply to that file.
While the intention of the breaking change was sound (don't mix information
sources; define a single source of truth), there were legitimate use-cases that
were broken as a result of this.
Apologies to everyone whose CI broke. We'll get this one right before long.
v1.1.2Compare Source
Fixed
buildmodule tobuild this module. Previously, there was a namespace conflict. (#640)
v1.1.1Compare Source
Fixed
README.md) in top-level (i.e.,site-packages/). (#657)v1.1.0Compare Source
Added
.kts).aidl).pem).vm,.vtl) (#554).xq(l|m|y|uery|)) (#610)statements (#602):
">(and variations such as'>," >, and"/>)] ::Changed
setup.pyand replaced it with a Poetry configuration. Maintainersbeware. (#600)
lintas an overridable argument. (#574)addheaderhas been renamed toannotate. The functionality remains thesame. (#550)
Deprecated
addheaderhas been deprecated. It still works, but is now undocumented.(#550)
Removed
setup.py. (#600)Poetry and not planned. (#600)
requestsremoved; usingurllib.requestfrom the standardlibrary instead. (#600)
Fixed
of Git no longer allow
git submodule add repository pathwhere repository isa file. A flag was added to explicitly allow this in the test framework.
(#619)
properly detected (#560)
comment style on a single line could not be parsed (#593).
<?php(#543).v1.0.0Compare Source
A major release! Do not worry, no breaking changes but a development team
(@carmenbianca, @floriansnow, @linozen, @mxmehl and @nicorikken) that is
confident enough to declare the REUSE helper tool stable, and a bunch of
long-awaited features!
Apart from smaller changes under the hood and typical maintenance tasks, the
main additions are new flags to the
addheadersubcommand that ease recursiveand automatic operations, the ability to ignore areas of a file that contain
strings that may falsely be detected as copyright or license statements, and the
option to merge copyright lines. The tool now also has better handling of some
edge cases with copyright and license identifiers.
We would like to thank the many contributors to this release, among them
@ajinkyapatil8190, @aspiers, @ferdnyc, @Gri-ffin, @hexagonrecursion, @hoijui,
@Jakelyst, @Liambeguin, @rex4539, @robinkrahl, @rpavlik, @siiptuo, @thbde and
@ventosus.
Added
using this tool and automating some steps that are not built into the tool
itself. (#500)
reuse lint. Simplyadd
REUSE-IgnoreStartandREUSE-IgnoreEndas comments and all linesbetween the two will be ignored by the next run of
reuse lint. (#463)by default. (#496)
.sbt).vim)--skip-existingflag toaddheaderin order to skip files thatalready contain SPDX information. This may be useful for only adding SPDX
information to newly created files. (#480)
--recursiveflag toaddheader. (#469)transforming multiple lines with a single year into a single line with a
range. (#328)
Changed
setuptoolsinstead of the deprecateddistutilswhich will be removedwith Python 3.12. (#451)
addheader --explicit-licenserenamed to--force-dot-license. (#476)docker. (#499)Copyright(c)andCopyright(C). (#440)Deprecated
--explicit-licensein favour of--force-dot-license.--explicit-licensewill remain useable (although undocumented) for theforeseeable future. (#476)
Removed
JsxCommentStylein favor of usingCCommentStyledirectly (see sectionFixed). (#406)Fixed
Apache-1.0+appears as a declared license, it should not be identified asmissing, bad, or unused if
LICENSES/Apache-1.0.txtexists. It is, however,identified separately as a used license. (#123)
addheadercreates a.licensefile, that file now has a newline at theend. (#477)
.jxsand.tsx) actually uses C comment syntax as JSX blocks neverstand at the beginning of the file where the licensing info needs to go.
(#406)
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.