Skip to content

Commit dacd4d3

Browse files
authored
refactor: REUSE tool setup in UI5 CLI repository (#1187)
JIRA: CPOUI5FOUNDATION-1150 - REUSE runs for every package, so that it's sure that each package compliance is correctly set and meets the criteria. - REUSE for the whole monorepo, so a report can be generated. Root level files are checked at this point
1 parent ce96601 commit dacd4d3

File tree

17 files changed

+354
-33
lines changed

17 files changed

+354
-33
lines changed

.github/workflows/reuse-compliance.yml

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,37 @@ on:
1212
permissions: {}
1313

1414
jobs:
15-
compliance-check:
15+
packages-compliance-check:
16+
name: Packages Compliance
17+
runs-on: ubuntu-24.04
18+
strategy:
19+
matrix:
20+
package:
21+
- "packages/builder"
22+
- "packages/cli"
23+
- "packages/documentation"
24+
- "packages/fs"
25+
- "packages/logger"
26+
- "packages/project"
27+
- "packages/server"
28+
steps:
29+
- uses: actions/checkout@v5
30+
31+
# Check each package if compliance is correctly set up.
32+
# Each one of these packages would be published separately.
33+
- name: Execute REUSE Compliance Check for ${{ matrix.package }}
34+
uses: fsfe/reuse-action@v6
35+
with:
36+
args: --root ${{ matrix.package }} lint
37+
38+
# Do the report for the whole repository, adding badge to the
39+
# README file.
40+
final-report:
1641
name: Compliance Check
17-
runs-on: ubuntu-latest
42+
needs: [packages-compliance-check]
43+
runs-on: ubuntu-24.04
1844
steps:
1945
- uses: actions/checkout@v5
20-
- name: Execute REUSE Compliance Check
46+
47+
- name: REUSE check for full repository
2148
uses: fsfe/reuse-action@v6

REUSE.toml

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,3 @@ precedence = "aggregate"
1010
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and UI5 CLI contributors"
1111
SPDX-License-Identifier = "Apache-2.0"
1212

13-
[[annotations]]
14-
path = "packages/server/lib/middleware/serveIndex/**"
15-
precedence = "aggregate"
16-
SPDX-FileCopyrightText = ["2010 Sencha Inc.", "2011 LearnBoost", "2011 TJ Holowaychuk", "2014-2015 Douglas Christopher Wilson"]
17-
SPDX-License-Identifier = "MIT"
18-
19-
[[annotations]]
20-
path = "packages/server/lib/middleware/testRunner/**"
21-
precedence = "aggregate"
22-
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and OpenUI5 contributors"
23-
SPDX-License-Identifier = "Apache-2.0"
24-
25-
[[annotations]]
26-
path = "packages/builder/lib/processors/jsdoc/lib/**"
27-
precedence = "aggregate"
28-
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and OpenUI5 contributors"
29-
SPDX-License-Identifier = "Apache-2.0"
30-
31-
[[annotations]]
32-
path = "packages/documentation/.vitepress/**"
33-
precedence = "aggregate"
34-
SPDX-FileCopyrightText = ["2019-present, Konrad Kost, Holger Schäfer, Yuxi (Evan) and VitePress contributors"]
35-
SPDX-License-Identifier = "MIT"

packages/builder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
> Modules for building UI5 projects
55
> Part of the [UI5 CLI](https://github.com/UI5/cli)
66
7-
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-builder)](https://api.reuse.software/info/github.com/SAP/ui5-builder)
7+
[![REUSE status](https://api.reuse.software/badge/github.com/UI5/cli)](https://api.reuse.software/info/github.com/UI5/cli)
88
[![npm Package Version](https://badge.fury.io/js/%40ui5%2Fbuilder.svg)](https://www.npmjs.com/package/@ui5/builder)
99
[![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-builder/badge.svg)](https://coveralls.io/github/SAP/ui5-builder)
1010

packages/builder/REUSE.toml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
version = 1
2+
SPDX-PackageName = "ui5-builder"
3+
SPDX-PackageSupplier = "SAP OpenUI5 <[email protected]>"
4+
SPDX-PackageDownloadLocation = "https://github.com/UI5/cli/tree/main/packages/builder"
5+
SPDX-PackageComment = "The code in this project may include calls to APIs (“API Calls”) of\n SAP or third-party products or services developed outside of this project\n (“External Products”).\n “APIs” means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project’s code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
6+
7+
[[annotations]]
8+
path = "**"
9+
precedence = "aggregate"
10+
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and UI5 CLI contributors"
11+
SPDX-License-Identifier = "Apache-2.0"
12+
13+
[[annotations]]
14+
path = "lib/processors/jsdoc/lib/**"
15+
precedence = "aggregate"
16+
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and OpenUI5 contributors"
17+
SPDX-License-Identifier = "Apache-2.0"

packages/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
> `ui5` Command Line Interface
55
> Part of the [UI5 CLI](https://github.com/UI5/cli)
66
7-
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-cli)](https://api.reuse.software/info/github.com/SAP/ui5-cli)
7+
[![REUSE status](https://api.reuse.software/badge/github.com/UI5/cli)](https://api.reuse.software/info/github.com/UI5/cli)
88
[![npm Package Version](https://badge.fury.io/js/%40ui5%2Fcli.svg)](https://www.npmjs.com/package/@ui5/cli)
99
[![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-cli/badge.svg)](https://coveralls.io/github/SAP/ui5-cli)
1010

packages/cli/REUSE.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version = 1
2+
SPDX-PackageName = "ui5-cli"
3+
SPDX-PackageSupplier = "SAP OpenUI5 <[email protected]>"
4+
SPDX-PackageDownloadLocation = "https://github.com/UI5/cli/tree/main/packages/cli"
5+
SPDX-PackageComment = "The code in this project may include calls to APIs (“API Calls”) of\n SAP or third-party products or services developed outside of this project\n (“External Products”).\n “APIs” means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project’s code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
6+
7+
[[annotations]]
8+
path = "**"
9+
precedence = "aggregate"
10+
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and UI5 CLI contributors"
11+
SPDX-License-Identifier = "Apache-2.0"
Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
Apache License
2+
3+
Version 2.0, January 2004
4+
5+
http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION,
6+
AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
11+
12+
"License" shall mean the terms and conditions for use, reproduction, and distribution
13+
as defined by Sections 1 through 9 of this document.
14+
15+
16+
17+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
18+
owner that is granting the License.
19+
20+
21+
22+
"Legal Entity" shall mean the union of the acting entity and all other entities
23+
that control, are controlled by, or are under common control with that entity.
24+
For the purposes of this definition, "control" means (i) the power, direct
25+
or indirect, to cause the direction or management of such entity, whether
26+
by contract or otherwise, or (ii) ownership of fifty percent (50%) or more
27+
of the outstanding shares, or (iii) beneficial ownership of such entity.
28+
29+
30+
31+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions
32+
granted by this License.
33+
34+
35+
36+
"Source" form shall mean the preferred form for making modifications, including
37+
but not limited to software source code, documentation source, and configuration
38+
files.
39+
40+
41+
42+
"Object" form shall mean any form resulting from mechanical transformation
43+
or translation of a Source form, including but not limited to compiled object
44+
code, generated documentation, and conversions to other media types.
45+
46+
47+
48+
"Work" shall mean the work of authorship, whether in Source or Object form,
49+
made available under the License, as indicated by a copyright notice that
50+
is included in or attached to the work (an example is provided in the Appendix
51+
below).
52+
53+
54+
55+
"Derivative Works" shall mean any work, whether in Source or Object form,
56+
that is based on (or derived from) the Work and for which the editorial revisions,
57+
annotations, elaborations, or other modifications represent, as a whole, an
58+
original work of authorship. For the purposes of this License, Derivative
59+
Works shall not include works that remain separable from, or merely link (or
60+
bind by name) to the interfaces of, the Work and Derivative Works thereof.
61+
62+
63+
64+
"Contribution" shall mean any work of authorship, including the original version
65+
of the Work and any modifications or additions to that Work or Derivative
66+
Works thereof, that is intentionally submitted to Licensor for inclusion in
67+
the Work by the copyright owner or by an individual or Legal Entity authorized
68+
to submit on behalf of the copyright owner. For the purposes of this definition,
69+
"submitted" means any form of electronic, verbal, or written communication
70+
sent to the Licensor or its representatives, including but not limited to
71+
communication on electronic mailing lists, source code control systems, and
72+
issue tracking systems that are managed by, or on behalf of, the Licensor
73+
for the purpose of discussing and improving the Work, but excluding communication
74+
that is conspicuously marked or otherwise designated in writing by the copyright
75+
owner as "Not a Contribution."
76+
77+
78+
79+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
80+
of whom a Contribution has been received by Licensor and subsequently incorporated
81+
within the Work.
82+
83+
2. Grant of Copyright License. Subject to the terms and conditions of this
84+
License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
85+
no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
86+
Derivative Works of, publicly display, publicly perform, sublicense, and distribute
87+
the Work and such Derivative Works in Source or Object form.
88+
89+
3. Grant of Patent License. Subject to the terms and conditions of this License,
90+
each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
91+
no-charge, royalty-free, irrevocable (except as stated in this section) patent
92+
license to make, have made, use, offer to sell, sell, import, and otherwise
93+
transfer the Work, where such license applies only to those patent claims
94+
licensable by such Contributor that are necessarily infringed by their Contribution(s)
95+
alone or by combination of their Contribution(s) with the Work to which such
96+
Contribution(s) was submitted. If You institute patent litigation against
97+
any entity (including a cross-claim or counterclaim in a lawsuit) alleging
98+
that the Work or a Contribution incorporated within the Work constitutes direct
99+
or contributory patent infringement, then any patent licenses granted to You
100+
under this License for that Work shall terminate as of the date such litigation
101+
is filed.
102+
103+
4. Redistribution. You may reproduce and distribute copies of the Work or
104+
Derivative Works thereof in any medium, with or without modifications, and
105+
in Source or Object form, provided that You meet the following conditions:
106+
107+
(a) You must give any other recipients of the Work or Derivative Works a copy
108+
of this License; and
109+
110+
(b) You must cause any modified files to carry prominent notices stating that
111+
You changed the files; and
112+
113+
(c) You must retain, in the Source form of any Derivative Works that You distribute,
114+
all copyright, patent, trademark, and attribution notices from the Source
115+
form of the Work, excluding those notices that do not pertain to any part
116+
of the Derivative Works; and
117+
118+
(d) If the Work includes a "NOTICE" text file as part of its distribution,
119+
then any Derivative Works that You distribute must include a readable copy
120+
of the attribution notices contained within such NOTICE file, excluding those
121+
notices that do not pertain to any part of the Derivative Works, in at least
122+
one of the following places: within a NOTICE text file distributed as part
123+
of the Derivative Works; within the Source form or documentation, if provided
124+
along with the Derivative Works; or, within a display generated by the Derivative
125+
Works, if and wherever such third-party notices normally appear. The contents
126+
of the NOTICE file are for informational purposes only and do not modify the
127+
License. You may add Your own attribution notices within Derivative Works
128+
that You distribute, alongside or as an addendum to the NOTICE text from the
129+
Work, provided that such additional attribution notices cannot be construed
130+
as modifying the License.
131+
132+
You may add Your own copyright statement to Your modifications and may provide
133+
additional or different license terms and conditions for use, reproduction,
134+
or distribution of Your modifications, or for any such Derivative Works as
135+
a whole, provided Your use, reproduction, and distribution of the Work otherwise
136+
complies with the conditions stated in this License.
137+
138+
5. Submission of Contributions. Unless You explicitly state otherwise, any
139+
Contribution intentionally submitted for inclusion in the Work by You to the
140+
Licensor shall be under the terms and conditions of this License, without
141+
any additional terms or conditions. Notwithstanding the above, nothing herein
142+
shall supersede or modify the terms of any separate license agreement you
143+
may have executed with Licensor regarding such Contributions.
144+
145+
6. Trademarks. This License does not grant permission to use the trade names,
146+
trademarks, service marks, or product names of the Licensor, except as required
147+
for reasonable and customary use in describing the origin of the Work and
148+
reproducing the content of the NOTICE file.
149+
150+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to
151+
in writing, Licensor provides the Work (and each Contributor provides its
152+
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
153+
KIND, either express or implied, including, without limitation, any warranties
154+
or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
155+
A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
156+
of using or redistributing the Work and assume any risks associated with Your
157+
exercise of permissions under this License.
158+
159+
8. Limitation of Liability. In no event and under no legal theory, whether
160+
in tort (including negligence), contract, or otherwise, unless required by
161+
applicable law (such as deliberate and grossly negligent acts) or agreed to
162+
in writing, shall any Contributor be liable to You for damages, including
163+
any direct, indirect, special, incidental, or consequential damages of any
164+
character arising as a result of this License or out of the use or inability
165+
to use the Work (including but not limited to damages for loss of goodwill,
166+
work stoppage, computer failure or malfunction, or any and all other commercial
167+
damages or losses), even if such Contributor has been advised of the possibility
168+
of such damages.
169+
170+
9. Accepting Warranty or Additional Liability. While redistributing the Work
171+
or Derivative Works thereof, You may choose to offer, and charge a fee for,
172+
acceptance of support, warranty, indemnity, or other liability obligations
173+
and/or rights consistent with this License. However, in accepting such obligations,
174+
You may act only on Your own behalf and on Your sole responsibility, not on
175+
behalf of any other Contributor, and only if You agree to indemnify, defend,
176+
and hold each Contributor harmless for any liability incurred by, or claims
177+
asserted against, such Contributor by reason of your accepting any such warranty
178+
or additional liability. END OF TERMS AND CONDITIONS
179+
180+
APPENDIX: How to apply the Apache License to your work.
181+
182+
To apply the Apache License to your work, attach the following boilerplate
183+
notice, with the fields enclosed by brackets "[]" replaced with your own identifying
184+
information. (Don't include the brackets!) The text should be enclosed in
185+
the appropriate comment syntax for the file format. We also recommend that
186+
a file or class name and description of purpose be included on the same "printed
187+
page" as the copyright notice for easier identification within third-party
188+
archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
194+
you may not use this file except in compliance with the License.
195+
196+
You may obtain a copy of the License at
197+
198+
http://www.apache.org/licenses/LICENSE-2.0
199+
200+
Unless required by applicable law or agreed to in writing, software
201+
202+
distributed under the License is distributed on an "AS IS" BASIS,
203+
204+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205+
206+
See the License for the specific language governing permissions and
207+
208+
limitations under the License.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
MIT License Copyright (c) <year> <copyright holders>
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice (including the next
11+
paragraph) shall be included in all copies or substantial portions of the
12+
Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
17+
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19+
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)