From 17bb29fb8a1f36373051db28455c7233edca9648 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 24 Apr 2025 07:24:13 +0200 Subject: [PATCH 01/16] #11 Relicence repo to EPL-2.0. --- LICENSES/EPL-2.0.txt | 277 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 277 insertions(+) create mode 100644 LICENSES/EPL-2.0.txt diff --git a/LICENSES/EPL-2.0.txt b/LICENSES/EPL-2.0.txt new file mode 100644 index 0000000..e23ece2 --- /dev/null +++ b/LICENSES/EPL-2.0.txt @@ -0,0 +1,277 @@ +Eclipse Public License - v 2.0 + + THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE + PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION + OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + + a) in the case of the initial Contributor, the initial content + Distributed under this Agreement, and + + b) in the case of each subsequent Contributor: + i) changes to the Program, and + ii) additions to the Program; + where such changes and/or additions to the Program originate from + and are Distributed by that particular Contributor. A Contribution + "originates" from a Contributor if it was added to the Program by + such Contributor itself or anyone acting on such Contributor's behalf. + Contributions do not include changes or additions to the Program that + are not Modified Works. + +"Contributor" means any person or entity that Distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which +are necessarily infringed by the use or sale of its Contribution alone +or when combined with the Program. + +"Program" means the Contributions Distributed in accordance with this +Agreement. + +"Recipient" means anyone who receives the Program under this Agreement +or any Secondary License (as applicable), including Contributors. + +"Derivative Works" shall mean any work, whether in Source Code or other +form, that is based on (or derived from) the Program and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. + +"Modified Works" shall mean any work in Source Code or other form that +results from an addition to, deletion from, or modification of the +contents of the Program, including, for purposes of clarity any new file +in Source Code form that contains any contents of the Program. Modified +Works shall not include works that contain only declarations, +interfaces, types, classes, structures, or files of the Program solely +in each case in order to link to, bind by name, or subclass the Program +or Modified Works thereof. + +"Distribute" means the acts of a) distributing or b) making available +in any manner that enables the transfer of a copy. + +"Source Code" means the form of a Program preferred for making +modifications, including but not limited to software source code, +documentation source, and configuration files. + +"Secondary License" means either the GNU General Public License, +Version 2.0, or any later versions of that license, including any +exceptions or additional permissions as identified by the initial +Contributor. + +2. GRANT OF RIGHTS + + a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare Derivative Works of, publicly display, + publicly perform, Distribute and sublicense the Contribution of such + Contributor, if any, and such Derivative Works. + + b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in Source Code or other form. This patent license shall + apply to the combination of the Contribution and the Program if, at + the time the Contribution is added by the Contributor, such addition + of the Contribution causes such combination to be covered by the + Licensed Patents. The patent license shall not apply to any other + combinations which include the Contribution. No hardware per se is + licensed hereunder. + + c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe the + patent or other intellectual property rights of any other entity. + Each Contributor disclaims any liability to Recipient for claims + brought by any other entity based on infringement of intellectual + property rights or otherwise. As a condition to exercising the + rights and licenses granted hereunder, each Recipient hereby + assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party + patent license is required to allow Recipient to Distribute the + Program, it is Recipient's responsibility to acquire that license + before distributing the Program. + + d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + + e) Notwithstanding the terms of any Secondary License, no + Contributor makes additional grants to any Recipient (other than + those set forth in this Agreement) as a result of such Recipient's + receipt of the Program under the terms of a Secondary License + (if permitted under the terms of Section 3). + +3. REQUIREMENTS + +3.1 If a Contributor Distributes the Program in any form, then: + + a) the Program must also be made available as Source Code, in + accordance with section 3.2, and the Contributor must accompany + the Program with a statement that the Source Code for the Program + is available under this Agreement, and informs Recipients how to + obtain it in a reasonable manner on or through a medium customarily + used for software exchange; and + + b) the Contributor may Distribute the Program under a license + different than this Agreement, provided that such license: + i) effectively disclaims on behalf of all other Contributors all + warranties and conditions, express and implied, including + warranties or conditions of title and non-infringement, and + implied warranties or conditions of merchantability and fitness + for a particular purpose; + + ii) effectively excludes on behalf of all other Contributors all + liability for damages, including direct, indirect, special, + incidental and consequential damages, such as lost profits; + + iii) does not attempt to limit or alter the recipients' rights + in the Source Code under section 3.2; and + + iv) requires any subsequent distribution of the Program by any + party to be under a license that satisfies the requirements + of this section 3. + +3.2 When the Program is Distributed as Source Code: + + a) it must be made available under this Agreement, or if the + Program (i) is combined with other material in a separate file or + files made available under a Secondary License, and (ii) the initial + Contributor attached to the Source Code the notice described in + Exhibit A of this Agreement, then the Program may be made available + under the terms of such Secondary Licenses, and + + b) a copy of this Agreement must be included with each copy of + the Program. + +3.3 Contributors may not remove or alter any copyright, patent, +trademark, attribution notices, disclaimers of warranty, or limitations +of liability ("notices") contained within the Program from any copy of +the Program which they Distribute, provided that Contributors may add +their own appropriate notices. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities +with respect to end users, business partners and the like. While this +license is intended to facilitate the commercial use of the Program, +the Contributor who includes the Program in a commercial product +offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes +the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and indemnify every +other Contributor ("Indemnified Contributor") against any losses, +damages and costs (collectively "Losses") arising from claims, lawsuits +and other legal actions brought by a third party against the Indemnified +Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program +in a commercial product offering. The obligations in this section do not +apply to any claims or Losses relating to any actual or alleged +intellectual property infringement. In order to qualify, an Indemnified +Contributor must: a) promptly notify the Commercial Contributor in +writing of such claim, and b) allow the Commercial Contributor to control, +and cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those performance +claims and warranties, and if a court requires any other Contributor to +pay any damages as a result, the Commercial Contributor must pay +those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR +IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF +TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all +risks associated with its exercise of rights under this Agreement, +including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs +or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS +SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST +PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other software +or hardware) infringes such Recipient's patent(s), then such Recipient's +rights granted under Section 2(b) shall terminate as of the date such +litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of +time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use +and distribution of the Program as soon as reasonably practicable. +However, Recipient's obligations under this Agreement and any licenses +granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, +but in order to avoid inconsistency the Agreement is copyrighted and +may only be modified in the following manner. The Agreement Steward +reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement +Steward has the right to modify this Agreement. The Eclipse Foundation +is the initial Agreement Steward. The Eclipse Foundation may assign the +responsibility to serve as the Agreement Steward to a suitable separate +entity. Each new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +Distributed subject to the version of the Agreement under which it was +received. In addition, after a new version of the Agreement is published, +Contributor may elect to Distribute the Program (including its +Contributions) under the new version. + +Except as expressly stated in Sections 2(a) and 2(b) above, Recipient +receives no rights or licenses to the intellectual property of any +Contributor under this Agreement, whether expressly, by implication, +estoppel or otherwise. All rights in the Program not expressly granted +under this Agreement are reserved. Nothing in this Agreement is intended +to be enforceable by any entity that is not a Contributor or Recipient. +No third-party beneficiary rights are created under this Agreement. + +Exhibit A - Form of Secondary Licenses Notice + +"This Source Code may also be made available under the following +Secondary Licenses when the conditions for such availability set forth +in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), +version(s), and exceptions or additional permissions here}." + + Simply including a copy of this Agreement, including this Exhibit A + is not sufficient to license the Source Code under Secondary Licenses. + + If it is not possible or desirable to put the notice in a particular + file, then You may include the notice in a location (such as a LICENSE + file in a relevant directory) where a recipient would be likely to + look for such a notice. + + You may add additional accurate notices of copyright ownership. \ No newline at end of file From d374a04ac66c939853b5a3148c8efd8ea43ce8c3 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 14:43:01 +0200 Subject: [PATCH 02/16] Changing headers to EPL. --- CODE_OF_CONDUCT.md | 16 +- CONTRIBUTING.md | 16 +- Dockerfile | 16 +- LICENSE | 478 +++++++++++++++++++++++----------------- LICENSES/Apache-2.0.txt | 73 ------ NOTICES.md | 16 +- README.md | 19 +- SECURITY.md | 16 +- tools/test_runner.sh | 16 +- 9 files changed, 313 insertions(+), 353 deletions(-) delete mode 100644 LICENSES/Apache-2.0.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d2689be..c1c0b7f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,17 +1,11 @@ # Community Code of Conduct diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1baebd..7a22db5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,11 @@ # Contributing to Eclipse Dash, Tools for Committers diff --git a/Dockerfile b/Dockerfile index 4cdf5e8..18ac9d3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,16 +1,10 @@ # Copyright (C) 2024 ETAS # -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 # Container image that runs your code FROM alpine:3.10 diff --git a/LICENSE b/LICENSE index f49a4e1..e23ece2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,277 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file +Eclipse Public License - v 2.0 + + THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE + PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION + OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + + a) in the case of the initial Contributor, the initial content + Distributed under this Agreement, and + + b) in the case of each subsequent Contributor: + i) changes to the Program, and + ii) additions to the Program; + where such changes and/or additions to the Program originate from + and are Distributed by that particular Contributor. A Contribution + "originates" from a Contributor if it was added to the Program by + such Contributor itself or anyone acting on such Contributor's behalf. + Contributions do not include changes or additions to the Program that + are not Modified Works. + +"Contributor" means any person or entity that Distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which +are necessarily infringed by the use or sale of its Contribution alone +or when combined with the Program. + +"Program" means the Contributions Distributed in accordance with this +Agreement. + +"Recipient" means anyone who receives the Program under this Agreement +or any Secondary License (as applicable), including Contributors. + +"Derivative Works" shall mean any work, whether in Source Code or other +form, that is based on (or derived from) the Program and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. + +"Modified Works" shall mean any work in Source Code or other form that +results from an addition to, deletion from, or modification of the +contents of the Program, including, for purposes of clarity any new file +in Source Code form that contains any contents of the Program. Modified +Works shall not include works that contain only declarations, +interfaces, types, classes, structures, or files of the Program solely +in each case in order to link to, bind by name, or subclass the Program +or Modified Works thereof. + +"Distribute" means the acts of a) distributing or b) making available +in any manner that enables the transfer of a copy. + +"Source Code" means the form of a Program preferred for making +modifications, including but not limited to software source code, +documentation source, and configuration files. + +"Secondary License" means either the GNU General Public License, +Version 2.0, or any later versions of that license, including any +exceptions or additional permissions as identified by the initial +Contributor. + +2. GRANT OF RIGHTS + + a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare Derivative Works of, publicly display, + publicly perform, Distribute and sublicense the Contribution of such + Contributor, if any, and such Derivative Works. + + b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in Source Code or other form. This patent license shall + apply to the combination of the Contribution and the Program if, at + the time the Contribution is added by the Contributor, such addition + of the Contribution causes such combination to be covered by the + Licensed Patents. The patent license shall not apply to any other + combinations which include the Contribution. No hardware per se is + licensed hereunder. + + c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe the + patent or other intellectual property rights of any other entity. + Each Contributor disclaims any liability to Recipient for claims + brought by any other entity based on infringement of intellectual + property rights or otherwise. As a condition to exercising the + rights and licenses granted hereunder, each Recipient hereby + assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party + patent license is required to allow Recipient to Distribute the + Program, it is Recipient's responsibility to acquire that license + before distributing the Program. + + d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + + e) Notwithstanding the terms of any Secondary License, no + Contributor makes additional grants to any Recipient (other than + those set forth in this Agreement) as a result of such Recipient's + receipt of the Program under the terms of a Secondary License + (if permitted under the terms of Section 3). + +3. REQUIREMENTS + +3.1 If a Contributor Distributes the Program in any form, then: + + a) the Program must also be made available as Source Code, in + accordance with section 3.2, and the Contributor must accompany + the Program with a statement that the Source Code for the Program + is available under this Agreement, and informs Recipients how to + obtain it in a reasonable manner on or through a medium customarily + used for software exchange; and + + b) the Contributor may Distribute the Program under a license + different than this Agreement, provided that such license: + i) effectively disclaims on behalf of all other Contributors all + warranties and conditions, express and implied, including + warranties or conditions of title and non-infringement, and + implied warranties or conditions of merchantability and fitness + for a particular purpose; + + ii) effectively excludes on behalf of all other Contributors all + liability for damages, including direct, indirect, special, + incidental and consequential damages, such as lost profits; + + iii) does not attempt to limit or alter the recipients' rights + in the Source Code under section 3.2; and + + iv) requires any subsequent distribution of the Program by any + party to be under a license that satisfies the requirements + of this section 3. + +3.2 When the Program is Distributed as Source Code: + + a) it must be made available under this Agreement, or if the + Program (i) is combined with other material in a separate file or + files made available under a Secondary License, and (ii) the initial + Contributor attached to the Source Code the notice described in + Exhibit A of this Agreement, then the Program may be made available + under the terms of such Secondary Licenses, and + + b) a copy of this Agreement must be included with each copy of + the Program. + +3.3 Contributors may not remove or alter any copyright, patent, +trademark, attribution notices, disclaimers of warranty, or limitations +of liability ("notices") contained within the Program from any copy of +the Program which they Distribute, provided that Contributors may add +their own appropriate notices. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities +with respect to end users, business partners and the like. While this +license is intended to facilitate the commercial use of the Program, +the Contributor who includes the Program in a commercial product +offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes +the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and indemnify every +other Contributor ("Indemnified Contributor") against any losses, +damages and costs (collectively "Losses") arising from claims, lawsuits +and other legal actions brought by a third party against the Indemnified +Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program +in a commercial product offering. The obligations in this section do not +apply to any claims or Losses relating to any actual or alleged +intellectual property infringement. In order to qualify, an Indemnified +Contributor must: a) promptly notify the Commercial Contributor in +writing of such claim, and b) allow the Commercial Contributor to control, +and cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those performance +claims and warranties, and if a court requires any other Contributor to +pay any damages as a result, the Commercial Contributor must pay +those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR +IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF +TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all +risks associated with its exercise of rights under this Agreement, +including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs +or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS +SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST +PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other software +or hardware) infringes such Recipient's patent(s), then such Recipient's +rights granted under Section 2(b) shall terminate as of the date such +litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of +time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use +and distribution of the Program as soon as reasonably practicable. +However, Recipient's obligations under this Agreement and any licenses +granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, +but in order to avoid inconsistency the Agreement is copyrighted and +may only be modified in the following manner. The Agreement Steward +reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement +Steward has the right to modify this Agreement. The Eclipse Foundation +is the initial Agreement Steward. The Eclipse Foundation may assign the +responsibility to serve as the Agreement Steward to a suitable separate +entity. Each new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +Distributed subject to the version of the Agreement under which it was +received. In addition, after a new version of the Agreement is published, +Contributor may elect to Distribute the Program (including its +Contributions) under the new version. + +Except as expressly stated in Sections 2(a) and 2(b) above, Recipient +receives no rights or licenses to the intellectual property of any +Contributor under this Agreement, whether expressly, by implication, +estoppel or otherwise. All rights in the Program not expressly granted +under this Agreement are reserved. Nothing in this Agreement is intended +to be enforceable by any entity that is not a Contributor or Recipient. +No third-party beneficiary rights are created under this Agreement. + +Exhibit A - Form of Secondary Licenses Notice + +"This Source Code may also be made available under the following +Secondary Licenses when the conditions for such availability set forth +in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), +version(s), and exceptions or additional permissions here}." + + Simply including a copy of this Agreement, including this Exhibit A + is not sufficient to license the Source Code under Secondary Licenses. + + If it is not possible or desirable to put the notice in a particular + file, then You may include the notice in a location (such as a LICENSE + file in a relevant directory) where a recipient would be likely to + look for such a notice. + + You may add additional accurate notices of copyright ownership. \ No newline at end of file diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt deleted file mode 100644 index 137069b..0000000 --- a/LICENSES/Apache-2.0.txt +++ /dev/null @@ -1,73 +0,0 @@ -Apache License -Version 2.0, January 2004 -http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - -"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. - -"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. - -"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. - -"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. - -"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. - -"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. - -"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). - -"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. - -"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." - -"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: - - (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. - - You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - -To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. - -Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/NOTICES.md b/NOTICES.md index ce0ff13..a7ff73e 100644 --- a/NOTICES.md +++ b/NOTICES.md @@ -1,17 +1,11 @@ # Notices for Eclipse Dash diff --git a/README.md b/README.md index 9d91f07..1cb77bf 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,11 @@ # QUality EVEnt Engine (quevee) github action diff --git a/SECURITY.md b/SECURITY.md index 84ee350..d5b935c 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,17 +1,11 @@ # Security Policy diff --git a/tools/test_runner.sh b/tools/test_runner.sh index 731fb07..a21f37a 100755 --- a/tools/test_runner.sh +++ b/tools/test_runner.sh @@ -2,17 +2,11 @@ # Copyright (C) 2024 ETAS # -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 export GITHUB_OUTPUT="manifest.toml" From 7a24e257017916e65b33b7aa430817e0ea9a161c Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 16:26:26 +0200 Subject: [PATCH 03/16] Simplify GH action for quevee. --- .github/workflows/release.yml | 35 ++++++--------------- Dockerfile | 7 +++-- action.yml | 35 +++++++++------------ manifest-toml.sh => sdv-manifest.sh | 47 +++++++++++++---------------- 4 files changed, 49 insertions(+), 75 deletions(-) rename manifest-toml.sh => sdv-manifest.sh (66%) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1d0ec7e..68d6bff 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -#on: [push] + on: push: tags: @@ -20,34 +20,23 @@ jobs: - name: Create release uses: softprops/action-gh-release@v2 id: create_release + - name: Show release URL run: | echo ${{ steps.create_release.outputs.url }} - # Upload artifacts to release - - name: Upload README to release - uses: svenstaro/upload-release-action@v2 - id: upload_readme - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: README.md - tag: ${{ github.ref }} - - name: Upload LICENSE to release - uses: svenstaro/upload-release-action@v2 - id: upload_license - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: LICENSE - tag: ${{ github.ref }} - # Do the quality artifact collection thing - name: Collect quality artifacts - uses: ./ # Uses an action in the root directory + uses: eclipse-dash/quevee id: quevee with: release_url: ${{ steps.create_release.outputs.url }} - artifacts_readme: ${{ steps.upload_readme.outputs.browser_download_url }} - artifacts_requirements: ${{ steps.upload_license.outputs.browser_download_url }},https://yet.another.org/example/artifact.bz2 + artefacts_requirements: docs/requirements.md + artefacts_testing: tests/ + artefacts_documentation: docs/getting_started/ + artefacts_coding_guidelines: docs/coding_guidelines.md + artefacts_release_process: https://example.org/my_release_process/ + - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 id: upload_manifest @@ -55,9 +44,3 @@ jobs: repo_token: ${{ secrets.GITHUB_TOKEN }} file: ${{ steps.quevee.outputs.manifest_file }} tag: ${{ github.ref }} - - name: Store quality manifest as workflow artifact - uses: actions/upload-artifact@v4 - id: store_manifest - with: - name: quality-artifacts-manifest - path: ${{ steps.quevee.outputs.manifest_file }} diff --git a/Dockerfile b/Dockerfile index 18ac9d3..f525ec5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,10 +1,11 @@ # Copyright (C) 2024 ETAS -# +# # This program and the accompanying materials are made # available under the terms of the Eclipse Public License 2.0 # which is available at https://www.eclipse.org/legal/epl-2.0/ # # SPDX-License-Identifier: EPL-2.0 +# # Container image that runs your code FROM alpine:3.10 @@ -13,7 +14,7 @@ FROM alpine:3.10 RUN apk add --no-cache bash # Copies your code file from your action repository to the filesystem path `/` of the container -COPY manifest-toml.sh /manifest-toml.sh +COPY sdv-manifest.sh /sdv-manifest.sh # Code file to execute when the docker container starts up (`entrypoint.sh`) -ENTRYPOINT ["/manifest-toml.sh"] +ENTRYPOINT ["/sdv-manifest.sh"] diff --git a/action.yml b/action.yml index 422dec2..60cff02 100644 --- a/action.yml +++ b/action.yml @@ -1,16 +1,11 @@ -# Copyright (C) 2024 ETAS +# Copyright (C) 2024 ETAS and other Eclipse Foundation contributors # -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 +# name: 'quevee' description: 'QUality-EVEnt Engine for collecting quality-related build and release artifacts' branding: @@ -23,18 +18,18 @@ inputs: artifacts_documentation: description: 'Comma-separated list of URLs of documentation artifacts' required: false - artifacts_license: - description: 'Comma-separated list of URLs containing licensing information' - required: false - artifacts_readme: - description: 'Comma-separated list of URLs of readme files' - required: false artifacts_requirements: description: 'Comma-separated list of URLs of requirement files' required: false artifacts_testing: description: 'Comma-separated list of URLs of test results' required: false + artifacts_coding_guidelines: + description: 'Comma-separated list of URLs of coding guidelines documents' + required: false + artifacts_release_process: + description: 'Comma-separated list of URLs of release process information' + required: false outputs: manifest_file: description: 'Process artifacts manifest file name' @@ -44,7 +39,7 @@ runs: args: - ${{ inputs.release_url }} - ${{ inputs.artifacts_documentation }} - - ${{ inputs.artifacts_license }} - - ${{ inputs.artifacts_readme }} - ${{ inputs.artifacts_requirements }} - ${{ inputs.artifacts_testing }} + - ${{ inputs.artifacts_coding_guidelines }} + - ${{ inputs.artifacts_release_process }} diff --git a/manifest-toml.sh b/sdv-manifest.sh similarity index 66% rename from manifest-toml.sh rename to sdv-manifest.sh index ab9d236..eebde61 100755 --- a/manifest-toml.sh +++ b/sdv-manifest.sh @@ -1,18 +1,14 @@ #!/bin/bash -# Copyright (C) 2024 ETAS -# +# ******************************************************************************** +# Copyright (c) 2025 ETAS and others +# # This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 +# terms of the Eclipse Public License 2.0 which is available at +# https://www.eclipse.org/legal/epl-2.0. +# +# +# SPDX-License-Identifier: EPL-2.0 time=$(date) owner=$(echo "$GITHUB_REPOSITORY" | cut -d '/' -f 1) @@ -25,7 +21,6 @@ fi generate_toml_header() { cat <>"$OUTPUT" -# Write artifact sections +# Write sections for var in $(env | grep "^INPUT_" | cut -d= -f1); do value="${!var}" case "$var" in - "INPUT_ARTIFACTS_DOCUMENTATION") - generate_toml_section "documentation" "$value" >>"$OUTPUT" + "INPUT_ARTEFACTS_REQUIREMENTS") + generate_toml_section "requirements" "$value" >>"$OUTPUT" ;; - "INPUT_ARTIFACTS_LICENSE") - generate_toml_section "licensing" "$value" >>"$OUTPUT" + "INPUT_ARTEFACTS_TESTING") + generate_toml_section "testing" "$value" >>"$OUTPUT" ;; - "INPUT_ARTIFACTS_README") - generate_toml_section "readme" "$value" >>"$OUTPUT" + "INPUT_ARTEFACTS_DOCUMENTATION") + generate_toml_section "documentation" "$value" >>"$OUTPUT" ;; - "INPUT_ARTIFACTS_REQUIREMENTS") - generate_toml_section "requirements" "$value" >>"$OUTPUT" + "INPUT_ARTEFACTS_CODING_GUIDELINES") + generate_toml_section "coding_guidelines" "$value" >>"$OUTPUT" ;; - "INPUT_ARTIFACTS_TESTING") - generate_toml_section "testing" "$value" >>"$OUTPUT" + "INPUT_ARTEFACTS_RELEASE_PROCESS") + generate_toml_section "release_process" "$value" >>"$OUTPUT" ;; *) - echo "Unknown artifact type ${var#INPUT_ARTIFACTS_}" + echo "Unknown artefact type ${var#INPUT_ARTEFACTS_}" ;; esac done From a1b528a88088fb85858da95afc35e4a7acb55942 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 16:44:31 +0200 Subject: [PATCH 04/16] Fix typos for action params. --- .github/workflows/release.yml | 8 ++++---- action.yml | 26 +++++++++++++------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 68d6bff..05031ef 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,8 +9,8 @@ concurrency: cancel-in-progress: true jobs: - quality_artifacts_job: - name: A job to collect quality artifacts + quality_artefacts_job: + name: A job to collect quality artefacts runs-on: ubuntu-latest permissions: write-all steps: @@ -25,8 +25,8 @@ jobs: run: | echo ${{ steps.create_release.outputs.url }} - # Do the quality artifact collection thing - - name: Collect quality artifacts + # Do the quality artefact collection thing + - name: Collect quality artefacts uses: eclipse-dash/quevee id: quevee with: diff --git a/action.yml b/action.yml index 60cff02..381f211 100644 --- a/action.yml +++ b/action.yml @@ -7,7 +7,7 @@ # SPDX-License-Identifier: EPL-2.0 # name: 'quevee' -description: 'QUality-EVEnt Engine for collecting quality-related build and release artifacts' +description: 'QUality-EVEnt Engine for collecting quality-related build and release artefacts' branding: icon: 'award' color: 'green' @@ -15,31 +15,31 @@ inputs: release_url: description: 'URL of the release this manifest refers to' required: false - artifacts_documentation: - description: 'Comma-separated list of URLs of documentation artifacts' + artefacts_documentation: + description: 'Comma-separated list of URLs of documentation artefacts' required: false - artifacts_requirements: + artefacts_requirements: description: 'Comma-separated list of URLs of requirement files' required: false - artifacts_testing: + artefacts_testing: description: 'Comma-separated list of URLs of test results' required: false - artifacts_coding_guidelines: + artefacts_coding_guidelines: description: 'Comma-separated list of URLs of coding guidelines documents' required: false - artifacts_release_process: + artefacts_release_process: description: 'Comma-separated list of URLs of release process information' required: false outputs: manifest_file: - description: 'Process artifacts manifest file name' + description: 'Process artefacts manifest file name' runs: using: 'docker' image: 'Dockerfile' args: - ${{ inputs.release_url }} - - ${{ inputs.artifacts_documentation }} - - ${{ inputs.artifacts_requirements }} - - ${{ inputs.artifacts_testing }} - - ${{ inputs.artifacts_coding_guidelines }} - - ${{ inputs.artifacts_release_process }} + - ${{ inputs.artefacts_documentation }} + - ${{ inputs.artefacts_requirements }} + - ${{ inputs.artefacts_testing }} + - ${{ inputs.artefacts_coding_guidelines }} + - ${{ inputs.artefacts_release_process }} From 34e3bb5cb8e1ac0e4f0601e0aa649c2d6904c8f1 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 16:51:27 +0200 Subject: [PATCH 05/16] Fix wrong order in params. --- action.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/action.yml b/action.yml index 381f211..4a6b0b2 100644 --- a/action.yml +++ b/action.yml @@ -15,15 +15,15 @@ inputs: release_url: description: 'URL of the release this manifest refers to' required: false - artefacts_documentation: - description: 'Comma-separated list of URLs of documentation artefacts' - required: false artefacts_requirements: description: 'Comma-separated list of URLs of requirement files' required: false artefacts_testing: description: 'Comma-separated list of URLs of test results' required: false + artefacts_documentation: + description: 'Comma-separated list of URLs of documentation artefacts' + required: false artefacts_coding_guidelines: description: 'Comma-separated list of URLs of coding guidelines documents' required: false @@ -38,8 +38,8 @@ runs: image: 'Dockerfile' args: - ${{ inputs.release_url }} - - ${{ inputs.artefacts_documentation }} - ${{ inputs.artefacts_requirements }} - ${{ inputs.artefacts_testing }} + - ${{ inputs.artefacts_documentation }} - ${{ inputs.artefacts_coding_guidelines }} - ${{ inputs.artefacts_release_process }} From f6f9fb3da381b3d439f66f00164f00f5b1b7be4d Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 16:57:39 +0200 Subject: [PATCH 06/16] Fix workflow yaml. --- .github/workflows/release.yml | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 05031ef..8b0774a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,13 +1,10 @@ - on: push: tags: - v* - concurrency: group: "release-${{ github.head_ref || github.ref }}" cancel-in-progress: true - jobs: quality_artefacts_job: name: A job to collect quality artefacts @@ -16,15 +13,12 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - - name: Create release uses: softprops/action-gh-release@v2 id: create_release - - name: Show release URL run: | echo ${{ steps.create_release.outputs.url }} - # Do the quality artefact collection thing - name: Collect quality artefacts uses: eclipse-dash/quevee @@ -32,11 +26,11 @@ jobs: with: release_url: ${{ steps.create_release.outputs.url }} artefacts_requirements: docs/requirements.md - artefacts_testing: tests/ - artefacts_documentation: docs/getting_started/ - artefacts_coding_guidelines: docs/coding_guidelines.md - artefacts_release_process: https://example.org/my_release_process/ - + artefacts_testing: tests/ + artefacts_documentation: docs/getting_started/ + artefacts_coding_guidelines: docs/coding_guidelines.md + artefacts_release_process: https://example.org/my_release_process/ + - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 id: upload_manifest From 2d90c206faf185fd0aff94364fd954465197ed4e Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 17:28:39 +0200 Subject: [PATCH 07/16] Provide external URLs for artefacts. --- sdv-manifest.sh | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/sdv-manifest.sh b/sdv-manifest.sh index eebde61..e3bc5f2 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -44,7 +44,8 @@ generate_toml_section() { if [ ${#array[@]} -gt 0 ]; then for element in "${array[@]}"; do validate_url $element - temp_output+=$'\n'" \"$element\"," + url=$( get_url_from_filename $element ) + temp_output+=$'\n'" \"$url\"," done cat < Date: Thu, 15 May 2025 17:32:33 +0200 Subject: [PATCH 08/16] Fix external URLs with gh url for artefacts. --- sdv-manifest.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdv-manifest.sh b/sdv-manifest.sh index e3bc5f2..2c11843 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -74,7 +74,7 @@ get_url_from_filename() { if [[ $filename =~ $regex ]]; then echo "$filename" else - echo "${GITHUB_REPOSITORY}/${GITHUB_WORKFLOW_SHA}/${filename}" + echo "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/${GITHUB_WORKFLOW_SHA}/${filename}" fi } From 1a7aaf6401f89325b978dbef886d85803ef24e40 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 18:05:44 +0200 Subject: [PATCH 09/16] Fix wrong URL + improve example. --- .github/workflows/release.yml | 10 ++++------ sdv-manifest.sh | 2 +- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8b0774a..55a9085 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,21 +19,19 @@ jobs: - name: Show release URL run: | echo ${{ steps.create_release.outputs.url }} - # Do the quality artefact collection thing + # Call the quevee gh action to create the manifest file for SDV maturity assessment. - name: Collect quality artefacts uses: eclipse-dash/quevee id: quevee with: release_url: ${{ steps.create_release.outputs.url }} artefacts_requirements: docs/requirements.md - artefacts_testing: tests/ - artefacts_documentation: docs/getting_started/ + artefacts_testing: tests/test_report.md + artefacts_documentation: docs/getting_started/README.md artefacts_coding_guidelines: docs/coding_guidelines.md - artefacts_release_process: https://example.org/my_release_process/ - + artefacts_release_process: https://example.org/docs/my_release_process.md - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 - id: upload_manifest with: repo_token: ${{ secrets.GITHUB_TOKEN }} file: ${{ steps.quevee.outputs.manifest_file }} diff --git a/sdv-manifest.sh b/sdv-manifest.sh index 2c11843..f7f7a04 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -74,7 +74,7 @@ get_url_from_filename() { if [[ $filename =~ $regex ]]; then echo "$filename" else - echo "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/${GITHUB_WORKFLOW_SHA}/${filename}" + echo "https://raw.githubusercontent.com/${GITHUB_REPOSITORY}/${GITHUB_WORKFLOW_SHA}/${filename}" fi } From 2bd09d1fceb3e1057297fa1f44300807c4c6b358 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 18:10:11 +0200 Subject: [PATCH 10/16] Improve documentation. --- README.md | 177 +++++++++++++++--------------------------------------- 1 file changed, 47 insertions(+), 130 deletions(-) diff --git a/README.md b/README.md index 1cb77bf..f60fa13 100644 --- a/README.md +++ b/README.md @@ -1,155 +1,72 @@ - -# QUality EVEnt Engine (quevee) github action - -This action accepts a set of input URLs pointing to release artifacts of various categories (like 'documentation' or 'testing'), and creates a toml file that contains project and release metadata as well as the artifact URLs. The goal is to document release artifacts that are relevant for assessment of project quality aspects, and present them for evaluation and archival in quality assessment processes. - -## Inputs - -### `release_url` - -URL of the release this manifest refers to. - -### `artifacts_documentation` - -Comma-separated list of URLs of documentation artifacts. - -### `artifacts_licensing` - -Comma-separated list of URLs of licensing information. - -### `artifacts_readme` - -Comma-separated list of URLs of readme files. - -### `artifacts_requirements` - -Comma-separated list of URLs of requirement files. -### `artifacts_testing` - -Comma-separated list of URLs of test results. - -## Outputs +# QUality EVEnt Engine (quevee) github action -### `manifest_file` +This action creates a `sdv-manifest.toml` file as a release asset, containing information required for the [SDV Maturity assessment](https://gitlab.eclipse.org/eclipse-wg/sdv-wg/sdv-technical-alignment/sdv-technical-topics/sdv-process/sdv-process-evaluation/-/blob/main/README.md) program. It takes as inputs a set of documents provided by the project, and formats it in a way that Eclipse SDV automation scripts can use to compute the level of maturity of the project according to the criteria defined in the program. -Process artifacts manifest file name. -## Simple example +## Usage -Conceptually, this is how quevee is used: +To use this action, one simply needs to add the following steps in their release action workflow: ```yaml -- name: Collect quality artifacts - uses: eclipse-dash/quevee@v0.4 - with: - artifacts_readme: - artifacts_requirements: , -``` - -This invocation will generate the following manifest structure: - -```toml -[metadata] - - -readme = [ - "readme-url", -] - -requirements = [ - "req-url1", - "req-url2", -] -``` - -## Realistic example - -A more complete example, applied to the quevee repository: - -```yaml -jobs: - quality_artifacts_job: - name: A job to collect quality artifacts - runs-on: ubuntu-latest - permissions: write-all - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Create release - uses: softprops/action-gh-release@v2 - id: create_release - - name: Show release URL - run: | - echo ${{ steps.create_release.outputs.url }} - - # Upload artifacts to release - - name: Upload README to release - uses: svenstaro/upload-release-action@v2 - id: upload_readme - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: README.md - tag: ${{ github.ref }} - - name: Upload LICENSE to release - uses: svenstaro/upload-release-action@v2 - id: upload_license - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: LICENSE - tag: ${{ github.ref }} - - # Collection quality artifacts - - name: Collect quality artifacts - uses: eclipse-dash/quevee@v0.4 + # Call the quevee gh action to create the manifest file for SDV maturity assessment. + - name: Collect quality artefacts + uses: eclipse-dash/quevee id: quevee with: release_url: ${{ steps.create_release.outputs.url }} - artifacts_readme: ${{ steps.upload_readme.outputs.browser_download_url }} - artifacts_requirements: ${{ steps.upload_license.outputs.browser_download_url }},https://my.org/example/artifact.bz2 + artefacts_requirements: + artefacts_testing: + artefacts_documentation: + artefacts_coding_guidelines: + artefacts_release_process: - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 - id: upload_manifest with: repo_token: ${{ secrets.GITHUB_TOKEN }} file: ${{ steps.quevee.outputs.manifest_file }} tag: ${{ github.ref }} - - name: Store quality manifest as workflow artifact - uses: actions/upload-artifact@v4 - id: store_manifest - with: - name: quality-artifacts-manifest - path: ${{ steps.quevee.outputs.manifest_file }} -```` -This invocation will generate the following manifest structure (test run on the quevee repository): +``` + +The various placeholders can either be: +* a path to the file within the repository, e.g. `docs/getting_started.md`, or +* a full URL to a resource, e.g. `https://myproject/docs/getting_started.pdf`. + +A more complete example can be found in the GitHub workflow of this repository: [.github/workflow/release.yml](.github/workflow/release.yml). + +## Output + +The action creates a file called `sdv-manifest.toml` as an asset of the release. Its content is as follows: ```toml -[metadata] -repo-url = "https://github.com/eclipse-dash/quevee" -created = "Sat Mar 9 18:20:29 UTC 2024" +repo-url = "https://github.com/borisbaldassari/quevee-test" +created = "Thu May 15 16:06:27 UTC 2025" by-action = "quevee" -project = "eclipse-dash" -repository = "quevee" -ref-tag = "v0.1.20" -git-hash = "22a0af5f8acb723801c85d5a8871019f5ff6f7ec" -release-url = "https://github.com/eclipse-dash/quevee/releases/tag/v0.1.20" +project = "borisbaldassari" +repository = "quevee-test" +ref-tag = "v0.0.9" +git-hash = "4ef764b812cf55e129408bfac792e16d8b5754b3" +release-url = "https://github.com/borisbaldassari/quevee-test/releases/tag/v0.0.9" requirements = [ - "https://github.com/eclipse-dash/quevee/releases/download/v0.1.20/LICENSE", - "https://my.org/example/artifact.bz2", + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/requirements.md", ] -readme = [ - "https://github.com/eclipse-dash/quevee/releases/download/v0.1.20/README.md", -] +coding_guidelines = [ + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/coding_guidelines.md", +] + +documentation = [ + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/getting_started/", +] + +release_process = [ + "https://example.org/my_release_process/", + ] + +testing = [ + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/tests/", + ] ``` + From 124d13a2f094b8faf3f6b1747642790817a9e7dc Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Thu, 15 May 2025 18:11:35 +0200 Subject: [PATCH 11/16] Improve/fix documentation. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f60fa13..374a35c 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The various placeholders can either be: * a path to the file within the repository, e.g. `docs/getting_started.md`, or * a full URL to a resource, e.g. `https://myproject/docs/getting_started.pdf`. -A more complete example can be found in the GitHub workflow of this repository: [.github/workflow/release.yml](.github/workflow/release.yml). +A more complete example can be found in the GitHub workflow of this repository: [.github/workflows/release.yml](.github/workflows/release.yml). ## Output From e5e3183ecdbbef1f97e02cb54ddf33b2ca1b6963 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Fri, 16 May 2025 06:56:12 +0200 Subject: [PATCH 12/16] Re-introduce readme artefact. --- .github/workflows/release.yml | 1 + action.yml | 4 ++++ sdv-manifest.sh | 3 +++ 3 files changed, 8 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 55a9085..94182f1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -25,6 +25,7 @@ jobs: id: quevee with: release_url: ${{ steps.create_release.outputs.url }} + artefacts_readme: README.md artefacts_requirements: docs/requirements.md artefacts_testing: tests/test_report.md artefacts_documentation: docs/getting_started/README.md diff --git a/action.yml b/action.yml index 4a6b0b2..2fb7952 100644 --- a/action.yml +++ b/action.yml @@ -15,6 +15,9 @@ inputs: release_url: description: 'URL of the release this manifest refers to' required: false + artefacts_readme: + description: 'Comma-separated list of URLs of READMEs' + required: false artefacts_requirements: description: 'Comma-separated list of URLs of requirement files' required: false @@ -38,6 +41,7 @@ runs: image: 'Dockerfile' args: - ${{ inputs.release_url }} + - ${{ inputs.artefacts_readme }} - ${{ inputs.artefacts_requirements }} - ${{ inputs.artefacts_testing }} - ${{ inputs.artefacts_documentation }} diff --git a/sdv-manifest.sh b/sdv-manifest.sh index f7f7a04..1803147 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -90,6 +90,9 @@ for var in $(env | grep "^INPUT_" | cut -d= -f1); do value="${!var}" case "$var" in + "INPUT_ARTEFACTS_README") + generate_toml_section "readme" "$value" >>"$OUTPUT" + ;; "INPUT_ARTEFACTS_REQUIREMENTS") generate_toml_section "requirements" "$value" >>"$OUTPUT" ;; From d312eb9f55720692db64346d28b9897e205006c9 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Fri, 16 May 2025 07:50:55 +0200 Subject: [PATCH 13/16] Improve documentation. --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 374a35c..0019e75 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ To use this action, one simply needs to add the following steps in their release with: release_url: ${{ steps.create_release.outputs.url }} artefacts_requirements: - artefacts_testing: + artefacts_testing: , artefacts_documentation: artefacts_coding_guidelines: artefacts_release_process: @@ -33,6 +33,32 @@ The various placeholders can either be: * a path to the file within the repository, e.g. `docs/getting_started.md`, or * a full URL to a resource, e.g. `https://myproject/docs/getting_started.pdf`. +If one needs to provide several files for a given criterion, there are two options: +* provide a comma-separated list of files, as shown for the artefacts_testing example above, or +* provide an archive, with a separate github action step. + +An example of a step archiving artefacts can be: +```yaml + - name: Gather Testing documents + shell: bash + run: | + tar cvz --file spec.tar.gz /path/to/dir + - name: Upload relevant spec files to release + uses: svenstaro/upload-release-action@v2 + id: upload_spec + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: spec.tar.gz + tag: ${{ github.ref }} +``` + +This in turn can be referenced in the quevee call as: +```yaml + ... + artifacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }} + ... +``` + A more complete example can be found in the GitHub workflow of this repository: [.github/workflows/release.yml](.github/workflows/release.yml). ## Output @@ -45,20 +71,24 @@ created = "Thu May 15 16:06:27 UTC 2025" by-action = "quevee" project = "borisbaldassari" repository = "quevee-test" -ref-tag = "v0.0.9" -git-hash = "4ef764b812cf55e129408bfac792e16d8b5754b3" -release-url = "https://github.com/borisbaldassari/quevee-test/releases/tag/v0.0.9" +ref-tag = "v0.1.3" +git-hash = "657a397af6f8e5249a519b5d63a5b8f64e763b29" +release-url = "https://github.com/borisbaldassari/quevee-test/releases/tag/v0.1.3" requirements = [ - "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/requirements.md", + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/docs/requirements.md", ] coding_guidelines = [ - "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/coding_guidelines.md", + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/docs/coding_guidelines.md", ] documentation = [ - "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/docs/getting_started/", + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/docs/getting_started/", +] + +readme = [ + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/README.md", ] release_process = [ @@ -66,7 +96,8 @@ release_process = [ ] testing = [ - "https://raw.githubusercontent.com/borisbaldassari/quevee-test/4ef764b812cf55e129408bfac792e16d8b5754b3/tests/", - ] + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/tests/file_1", + "https://raw.githubusercontent.com/borisbaldassari/quevee-test/657a397af6f8e5249a519b5d63a5b8f64e763b29/tests/file_2", +] ``` From a5a6cc566490ff737e96fb95b968534930865828 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Fri, 16 May 2025 08:09:57 +0200 Subject: [PATCH 14/16] Fix wrong regex + fix endless appending in action script. --- sdv-manifest.sh | 8 ++++---- tools/test_runner.sh | 13 ++++++++----- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/sdv-manifest.sh b/sdv-manifest.sh index 1803147..84013c7 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -43,8 +43,8 @@ generate_toml_section() { if [ ${#array[@]} -gt 0 ]; then for element in "${array[@]}"; do - validate_url $element url=$( get_url_from_filename $element ) + validate_url $url temp_output+=$'\n'" \"$url\"," done @@ -59,10 +59,10 @@ EOF # Validate URL using regex validate_url() { local url="$1" - local regex="^(http|https)://[a-zA-Z0-9\-\.]+\.[a-zA-Z]{2,}(:[0-9]+)?(/[a-zA-Z0-9\-\._\?\,\'/\\\+&%\$#\=~]*)?$" + local regex="^(http|https)://[a-zA-Z0-9\-\.]+\.[a-zA-Z]{2,}(/[-a-zA-Z0-9\._\?\,\'/\\\+&%\$#\=~]*)?$" if [[ ! $url =~ $regex ]]; then - echo "Invalid URL: $url" >&2 + echo "Invalid URL: [$url]" >&2 fi } @@ -83,7 +83,7 @@ get_url_from_filename() { OUTPUT="sdv-manifest.toml" # Write header section -generate_toml_header >>"$OUTPUT" +generate_toml_header >"$OUTPUT" # Write sections for var in $(env | grep "^INPUT_" | cut -d= -f1); do diff --git a/tools/test_runner.sh b/tools/test_runner.sh index a21f37a..3fc4dab 100755 --- a/tools/test_runner.sh +++ b/tools/test_runner.sh @@ -8,15 +8,18 @@ # # SPDX-License-Identifier: EPL-2.0 -export GITHUB_OUTPUT="manifest.toml" +export GITHUB_OUTPUT="sdv-manifest.toml" export GITHUB_SERVER_URL=https://github.com export GITHUB_REPOSITORY=eclipse-dash/quevee export GITHUB_REF_NAME=main export GITHUB_WORKFLOW_SHA=e69b6ff8f67e0d2edfd0968ebc5f99d7e8d763c7 -export INPUT_ARTIFACTS_README="https://some.example.url,https://other.example.url" -export INPUT_ARTIFACTS_REQUIREMENTS="./Another/URL,https://another.org/example/artifact.bz2" -export INPUT_ARTIFACTS_DOCUMENTATION="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip" +export INPUT_ARTEFACTS_README="https://some.example.url,https://other.example.url" +export INPUT_ARTEFACTS_REQUIREMENTS="another/file.md,https://another.org/example-test/artefact.bz2" +export INPUT_ARTEFACTS_TESTING="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip" +export INPUT_ARTEFACTS_DOCUMENTATION="./Random/URL,https://another.org/example/artefact.bz2" +export INPUT_ARTEFACTS_CODING_GUIDELINES="./SomeOther/URL,https://another.org/example/artefact.bz2" +export INPUT_ARTEFACTS_RELEASE_PROCESS="./YetAnother/URL,https://another.org/example/artefact.bz2" -./manifest-toml.sh +./sdv-manifest.sh From e52ca42fd9ec90a4f358c9eb0fcbc21814999dcf Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Fri, 16 May 2025 08:18:52 +0200 Subject: [PATCH 15/16] Fix typo in readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0019e75..500ca96 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ An example of a step archiving artefacts can be: This in turn can be referenced in the quevee call as: ```yaml ... - artifacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }} + artefacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }} ... ``` From cfcbeff189d6e65d63e3b14e2ddbfd37abace756 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Fri, 16 May 2025 08:33:43 +0200 Subject: [PATCH 16/16] Switching back to artIfacts. --- .github/workflows/release.yml | 18 +++++++++--------- README.md | 18 +++++++++--------- action.yml | 30 +++++++++++++++--------------- sdv-manifest.sh | 14 +++++++------- tools/test_runner.sh | 12 ++++++------ 5 files changed, 46 insertions(+), 46 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 94182f1..f6bbc95 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -6,8 +6,8 @@ concurrency: group: "release-${{ github.head_ref || github.ref }}" cancel-in-progress: true jobs: - quality_artefacts_job: - name: A job to collect quality artefacts + quality_artifacts_job: + name: A job to collect quality artifacts runs-on: ubuntu-latest permissions: write-all steps: @@ -20,17 +20,17 @@ jobs: run: | echo ${{ steps.create_release.outputs.url }} # Call the quevee gh action to create the manifest file for SDV maturity assessment. - - name: Collect quality artefacts + - name: Collect quality artifacts uses: eclipse-dash/quevee id: quevee with: release_url: ${{ steps.create_release.outputs.url }} - artefacts_readme: README.md - artefacts_requirements: docs/requirements.md - artefacts_testing: tests/test_report.md - artefacts_documentation: docs/getting_started/README.md - artefacts_coding_guidelines: docs/coding_guidelines.md - artefacts_release_process: https://example.org/docs/my_release_process.md + artifacts_readme: README.md + artifacts_requirements: docs/requirements.md + artifacts_testing: tests/test_report.md + artifacts_documentation: docs/getting_started/README.md + artifacts_coding_guidelines: docs/coding_guidelines.md + artifacts_release_process: https://example.org/docs/my_release_process.md - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 with: diff --git a/README.md b/README.md index 500ca96..beda7e0 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,16 @@ To use this action, one simply needs to add the following steps in their release ```yaml # Call the quevee gh action to create the manifest file for SDV maturity assessment. - - name: Collect quality artefacts + - name: Collect quality artifacts uses: eclipse-dash/quevee id: quevee with: release_url: ${{ steps.create_release.outputs.url }} - artefacts_requirements: - artefacts_testing: , - artefacts_documentation: - artefacts_coding_guidelines: - artefacts_release_process: + artifacts_requirements: + artifacts_testing: , + artifacts_documentation: + artifacts_coding_guidelines: + artifacts_release_process: - name: Upload quality manifest to release uses: svenstaro/upload-release-action@v2 with: @@ -34,10 +34,10 @@ The various placeholders can either be: * a full URL to a resource, e.g. `https://myproject/docs/getting_started.pdf`. If one needs to provide several files for a given criterion, there are two options: -* provide a comma-separated list of files, as shown for the artefacts_testing example above, or +* provide a comma-separated list of files, as shown for the artifacts_testing example above, or * provide an archive, with a separate github action step. -An example of a step archiving artefacts can be: +An example of a step archiving artifacts can be: ```yaml - name: Gather Testing documents shell: bash @@ -55,7 +55,7 @@ An example of a step archiving artefacts can be: This in turn can be referenced in the quevee call as: ```yaml ... - artefacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }} + artifacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }} ... ``` diff --git a/action.yml b/action.yml index 2fb7952..8ad0d69 100644 --- a/action.yml +++ b/action.yml @@ -7,7 +7,7 @@ # SPDX-License-Identifier: EPL-2.0 # name: 'quevee' -description: 'QUality-EVEnt Engine for collecting quality-related build and release artefacts' +description: 'QUality-EVEnt Engine for collecting quality-related build and release artifacts' branding: icon: 'award' color: 'green' @@ -15,35 +15,35 @@ inputs: release_url: description: 'URL of the release this manifest refers to' required: false - artefacts_readme: + artifacts_readme: description: 'Comma-separated list of URLs of READMEs' required: false - artefacts_requirements: + artifacts_requirements: description: 'Comma-separated list of URLs of requirement files' required: false - artefacts_testing: + artifacts_testing: description: 'Comma-separated list of URLs of test results' required: false - artefacts_documentation: - description: 'Comma-separated list of URLs of documentation artefacts' + artifacts_documentation: + description: 'Comma-separated list of URLs of documentation artifacts' required: false - artefacts_coding_guidelines: + artifacts_coding_guidelines: description: 'Comma-separated list of URLs of coding guidelines documents' required: false - artefacts_release_process: + artifacts_release_process: description: 'Comma-separated list of URLs of release process information' required: false outputs: manifest_file: - description: 'Process artefacts manifest file name' + description: 'Process artifacts manifest file name' runs: using: 'docker' image: 'Dockerfile' args: - ${{ inputs.release_url }} - - ${{ inputs.artefacts_readme }} - - ${{ inputs.artefacts_requirements }} - - ${{ inputs.artefacts_testing }} - - ${{ inputs.artefacts_documentation }} - - ${{ inputs.artefacts_coding_guidelines }} - - ${{ inputs.artefacts_release_process }} + - ${{ inputs.artifacts_readme }} + - ${{ inputs.artifacts_requirements }} + - ${{ inputs.artifacts_testing }} + - ${{ inputs.artifacts_documentation }} + - ${{ inputs.artifacts_coding_guidelines }} + - ${{ inputs.artifacts_release_process }} diff --git a/sdv-manifest.sh b/sdv-manifest.sh index 84013c7..c1a2235 100755 --- a/sdv-manifest.sh +++ b/sdv-manifest.sh @@ -90,26 +90,26 @@ for var in $(env | grep "^INPUT_" | cut -d= -f1); do value="${!var}" case "$var" in - "INPUT_ARTEFACTS_README") + "INPUT_ARTIFACTS_README") generate_toml_section "readme" "$value" >>"$OUTPUT" ;; - "INPUT_ARTEFACTS_REQUIREMENTS") + "INPUT_ARTIFACTS_REQUIREMENTS") generate_toml_section "requirements" "$value" >>"$OUTPUT" ;; - "INPUT_ARTEFACTS_TESTING") + "INPUT_ARTIFACTS_TESTING") generate_toml_section "testing" "$value" >>"$OUTPUT" ;; - "INPUT_ARTEFACTS_DOCUMENTATION") + "INPUT_ARTIFACTS_DOCUMENTATION") generate_toml_section "documentation" "$value" >>"$OUTPUT" ;; - "INPUT_ARTEFACTS_CODING_GUIDELINES") + "INPUT_ARTIFACTS_CODING_GUIDELINES") generate_toml_section "coding_guidelines" "$value" >>"$OUTPUT" ;; - "INPUT_ARTEFACTS_RELEASE_PROCESS") + "INPUT_ARTIFACTS_RELEASE_PROCESS") generate_toml_section "release_process" "$value" >>"$OUTPUT" ;; *) - echo "Unknown artefact type ${var#INPUT_ARTEFACTS_}" + echo "Unknown artifact type ${var#INPUT_ARTIFACTS_}" ;; esac done diff --git a/tools/test_runner.sh b/tools/test_runner.sh index 3fc4dab..5d1694c 100755 --- a/tools/test_runner.sh +++ b/tools/test_runner.sh @@ -15,11 +15,11 @@ export GITHUB_REPOSITORY=eclipse-dash/quevee export GITHUB_REF_NAME=main export GITHUB_WORKFLOW_SHA=e69b6ff8f67e0d2edfd0968ebc5f99d7e8d763c7 -export INPUT_ARTEFACTS_README="https://some.example.url,https://other.example.url" -export INPUT_ARTEFACTS_REQUIREMENTS="another/file.md,https://another.org/example-test/artefact.bz2" -export INPUT_ARTEFACTS_TESTING="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip" -export INPUT_ARTEFACTS_DOCUMENTATION="./Random/URL,https://another.org/example/artefact.bz2" -export INPUT_ARTEFACTS_CODING_GUIDELINES="./SomeOther/URL,https://another.org/example/artefact.bz2" -export INPUT_ARTEFACTS_RELEASE_PROCESS="./YetAnother/URL,https://another.org/example/artefact.bz2" +export INPUT_ARTIFACTS_README="https://some.example.url,https://other.example.url" +export INPUT_ARTIFACTS_REQUIREMENTS="another/file.md,https://another.org/example-test/artifact.bz2" +export INPUT_ARTIFACTS_TESTING="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip" +export INPUT_ARTIFACTS_DOCUMENTATION="./Random/URL,https://another.org/example/artifact.bz2" +export INPUT_ARTIFACTS_CODING_GUIDELINES="./SomeOther/URL,https://another.org/example/artifact.bz2" +export INPUT_ARTIFACTS_RELEASE_PROCESS="./YetAnother/URL,https://another.org/example/artifact.bz2" ./sdv-manifest.sh