├── SECURITY.md ├── .editorconfig ├── tools └── sanity-check │ ├── requirements.txt │ ├── DEPENDENCIES │ ├── README.md │ └── check.py ├── .github └── workflows │ └── sanity-check.yml ├── RELEASE.md ├── .tractusx ├── README.md ├── NOTICE.md ├── .gitignore ├── CONTRIBUTING.md ├── CODE_OF_CONDUCT.md ├── LICENSE └── LICENSE_non-code /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | Please report a found vulnerability here: 6 | [https://www.eclipse.org/security/](https://www.eclipse.org/security/) 7 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig is awesome: https://EditorConfig.org 2 | 3 | # top-most EditorConfig file 4 | root = true 5 | 6 | [*] 7 | end_of_line = lf 8 | insert_final_newline = true 9 | charset = utf-8 10 | indent_style = space 11 | indent_size = 4 12 | -------------------------------------------------------------------------------- /tools/sanity-check/requirements.txt: -------------------------------------------------------------------------------- 1 | certifi==2024.7.4 2 | charset-normalizer==3.3.2 3 | idna==3.7 4 | numpy==1.26.4 5 | pandas==2.2.2 6 | python-dateutil==2.9.0.post0 7 | pytz==2024.1 8 | requests==2.32.2 9 | six==1.16.0 10 | tzdata==2024.1 11 | urllib3==2.2.2 12 | -------------------------------------------------------------------------------- /.github/workflows/sanity-check.yml: -------------------------------------------------------------------------------- 1 | name: Sanity Check 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | release: 7 | description: 'Release version (e.g. 24.05)' 8 | required: true 9 | type: string 10 | 11 | jobs: 12 | run-sanity-check: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v4 17 | - name: Set up Python 3.10 18 | uses: actions/setup-python@v5 19 | with: 20 | python-version: '3.10' 21 | - name: Install dependencies 22 | run: | 23 | python -m venv venv 24 | source venv/bin/activate 25 | pip install -r tools/sanity-check/requirements.txt 26 | - name: Run sanity-check 27 | run: | 28 | source venv/bin/activate 29 | python tools/sanity-check/check.py CHANGELOG.md ${{ github.event.inputs.release }} 30 | 31 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | # Tractus-X release process 2 | 3 | Welcome to tractus-x-release, repository of the periodic release bundles: 4 | - check the current and recent release tags to identify content which was published so far 5 | - check the change log(s) for content, known knowns, and backward compatibility since calendar versioning scheme shows the year and month of release. 6 | 7 | We recommend you to visit the [sig-release repo](https://github.com/eclipse-tractusx/sig-release) and start with the [README.md](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md) for a consolidated package on Release-relevant information. 8 | 9 | Goto [sig-release/README.md](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md) for a consolidated package on Release-relevant information. 10 | 11 | Visit [tractus-x-release/CHANGELOG.md](https://github.com/eclipse-tractusx/tractus-x-release/blob/main/CHANGELOG.md) for our periodic release info. 12 | -------------------------------------------------------------------------------- /.tractusx: -------------------------------------------------------------------------------- 1 | ############################################################### 2 | # Copyright (c) 2023 Contributors to the Eclipse Foundation 3 | # 4 | # See the NOTICE file(s) distributed with this work for additional 5 | # information regarding copyright ownership. 6 | # 7 | # This program and the accompanying materials are made available under the 8 | # terms of the Apache License, Version 2.0 which is available at 9 | # https://www.apache.org/licenses/LICENSE-2.0. 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 | # License for the specific language governing permissions and limitations 15 | # under the License. 16 | # 17 | # SPDX-License-Identifier: Apache-2.0 18 | ############################################################### 19 | product: "Tractus-X-Release" 20 | leadingRepository: "https://github.com/eclipse-tractusx/tractus-x-release" 21 | repoCategory: "support" 22 | repositories: 23 | - name: "tractus-x-release" 24 | usage: "This is the central Eclipse Tractus-X release repository." 25 | url: "https://github.com/eclipse-tractusx/tractus-x-release" 26 | -------------------------------------------------------------------------------- /tools/sanity-check/DEPENDENCIES: -------------------------------------------------------------------------------- 1 | pypi/pypi/-/certifi/2024.2.2, MPL-2.0, approved, clearlydefined 2 | pypi/pypi/-/charset-normalizer/3.3.2, MIT AND (LGPL-2.1-only AND MIT) AND LGPL-2.1-only AND CC-BY-SA-3.0, approved, #13067 3 | pypi/pypi/-/idna/3.7, BSD-3-Clause AND Unicode-TOU, approved, #14864 4 | pypi/pypi/-/numpy/1.26.4, Apache-2.0 AND BSD-2-Clause AND BSD-3-Clause AND CC0-1.0 AND CC-BY-4.0 AND CC-BY-SA-3.0 AND (BSL-1.0 OR Zlib) AND (NCSA OR BSD-3-Clause) AND SunPro AND FSFAP AND MIT AND MIT-Modern-Variant AND LicenseRef-Public-domain AND Vim AND Zlib, approved, #12087 5 | pypi/pypi/-/pandas/2.2.2, BSD-2-Clause AND BSD-3-Clause AND (BSD-3-Clause AND TCL) AND (Apache-2.0 AND BSD-3-Clause) AND Python-2.0.1 AND MIT AND LicenseRef-Permission-Notice AND LicenseRef-Public-domain, approved, #13994 6 | pypi/pypi/-/python-dateutil/2.9.0.post0, Apache-2.0 AND BSD-3-Clause AND (Apache-2.0 AND BSD-3-Clause), approved, #13992 7 | pypi/pypi/-/pytz/2024.1, MIT AND (MIT AND ZPL-2.1), approved, #13993 8 | pypi/pypi/-/requests/2.32.2, Apache-2.0 AND MIT AND Apache-2.0, approved, #14884 9 | pypi/pypi/-/six/1.16.0, MIT, approved, clearlydefined 10 | pypi/pypi/-/tzdata/2024.1, Apache-2.0, approved, #13995 11 | pypi/pypi/-/urllib3/2.2.1, MIT AND LicenseRef-Python, approved, #13081 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Eclipse Tractus-X 2 | 3 | This is the central [Eclipse Tractus-X](https://projects.eclipse.org/projects/automotive.tractusx) release repository. 4 | As Eclipse Tractus-X contains multiply components / products, this repository reflects the 5 | unified official release of the Eclipse Tractus-X distribution. 6 | 7 | ## Minimum requirement 8 | 9 | Eclipse Tractus-X components are based on modern cloud technology and require a current Kubernetes Cluster. You need to be able to install Helm Charts. For supported Kubernetes Versions and technical details, please refer to the [CHANGELOG.md](CHANGELOG.md) and to the product specific README.md. 10 | 11 | ## How to install Eclipse Tractus-X 12 | 13 | All components are based on [Helm](https://helm.sh/) Charts. To find the right versions of them, see our overarching [CHANGELOG.md](CHANGELOG.md) for versions which are compatible with each other because they have been tested and released together. All components have their own installation guides. 14 | 15 | ## Schedule 16 | 17 | Tractus-X releases follow a quarterly schedule. In addition to the overarching quarterly release, single product 18 | releases take place on demand. 19 | The overarching release is done to ensure compatibility, quality standards and alignment between Eclipse Tractus-X products. 20 | 21 | ## Release process 22 | 23 | For more information on the release process for components / products, please see [RELEASE.md](RELEASE.md). 24 | -------------------------------------------------------------------------------- /NOTICE.md: -------------------------------------------------------------------------------- 1 | # Notices for Eclipse Tractus-X 2 | 3 | This content is produced and maintained by the Eclipse Tractus-X project. 4 | 5 | * Project home: https://projects.eclipse.org/projects/automotive.tractusx 6 | 7 | See the AUTHORS file(s) distributed with this work for additional information regarding authorship. 8 | 9 | ## Trademarks 10 | 11 | Eclipse Tractus-X is a trademark of the Eclipse Foundation. 12 | 13 | ## Copyright 14 | 15 | All content is the property of the respective authors or their employers. For 16 | more information regarding authorship of content, please consult the listed 17 | source code repository logs. 18 | 19 | ## Declared Project Licenses 20 | 21 | The Tractus-X project uses the following licenses: 22 | 23 | - Apache-2.0 for code 24 | - CC-BY-4.0 for non-code 25 | 26 | Apache-2.0: 27 | 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. 28 | SPDX-License-Identifier: Apache-2.0 29 | 30 | CC-BY-4.0: 31 | The materials in this repository are made available under the terms of the Creative Commons Attribution 4.0 International License, which is available at https://spdx.org/licenses/CC-BY-4.0.html. 32 | SPDX-License-Identifier: CC-BY-4.0 33 | 34 | ## Source Code 35 | 36 | The project maintains the following source code repositories: 37 | 38 | * https://github.com/eclipse/tractusx 39 | 40 | 41 | 42 | ## Third-party Content 43 | 44 | This project leverages the following third party content. 45 | 46 | NO 47 | 48 | ## Cryptography 49 | 50 | Content may contain encryption software. The country in which you are currently 51 | may have restrictions on the import, possession, and use, and/or re-export to 52 | another country, of encryption software. BEFORE using any encryption software, 53 | please check the country's laws, regulations and policies concerning the import, 54 | possession, or use, and re-export of encryption software, to see if this is 55 | permitted. 56 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/jetbrains+all 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=jetbrains+all 3 | 4 | ### JetBrains+all ### 5 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 6 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 7 | 8 | # User-specific stuff 9 | .idea/**/workspace.xml 10 | .idea/**/tasks.xml 11 | .idea/**/usage.statistics.xml 12 | .idea/**/dictionaries 13 | .idea/**/shelf 14 | 15 | # AWS User-specific 16 | .idea/**/aws.xml 17 | 18 | # Generated files 19 | .idea/**/contentModel.xml 20 | 21 | # Sensitive or high-churn files 22 | .idea/**/dataSources/ 23 | .idea/**/dataSources.ids 24 | .idea/**/dataSources.local.xml 25 | .idea/**/sqlDataSources.xml 26 | .idea/**/dynamic.xml 27 | .idea/**/uiDesigner.xml 28 | .idea/**/dbnavigator.xml 29 | 30 | # Gradle 31 | .idea/**/gradle.xml 32 | .idea/**/libraries 33 | 34 | # Gradle and Maven with auto-import 35 | # When using Gradle or Maven with auto-import, you should exclude module files, 36 | # since they will be recreated, and may cause churn. Uncomment if using 37 | # auto-import. 38 | # .idea/artifacts 39 | # .idea/compiler.xml 40 | # .idea/jarRepositories.xml 41 | .idea/modules.xml 42 | .idea/*.iml 43 | # .idea/modules 44 | # *.iml 45 | # *.ipr 46 | 47 | # CMake 48 | cmake-build-*/ 49 | 50 | # Mongo Explorer plugin 51 | .idea/**/mongoSettings.xml 52 | 53 | # File-based project format 54 | *.iws 55 | 56 | # IntelliJ 57 | out/ 58 | 59 | # mpeltonen/sbt-idea plugin 60 | .idea_modules/ 61 | 62 | # JIRA plugin 63 | atlassian-ide-plugin.xml 64 | 65 | # Cursive Clojure plugin 66 | .idea/replstate.xml 67 | 68 | # SonarLint plugin 69 | .idea/sonarlint/ 70 | 71 | # Crashlytics plugin (for Android Studio and IntelliJ) 72 | com_crashlytics_export_strings.xml 73 | crashlytics.properties 74 | crashlytics-build.properties 75 | fabric.properties 76 | 77 | # Editor-based Rest Client 78 | .idea/httpRequests 79 | 80 | # Android studio 3.1+ serialized cache file 81 | .idea/caches/build_file_checksums.ser 82 | 83 | ### JetBrains+all Patch ### 84 | # Ignore everything but code style settings and run configurations 85 | # that are supposed to be shared within teams. 86 | 87 | .idea/* 88 | 89 | !.idea/codeStyles 90 | !.idea/runConfigurations 91 | 92 | # End of https://www.toptal.com/developers/gitignore/api/jetbrains+all 93 | 94 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Eclipse Tractus-X 2 | 3 | Thanks for your interest in this project. 4 | 5 | ## Project description 6 | 7 | The companies involved want to increase the automotive industry's 8 | competitiveness, improve efficiency through industry-specific cooperation and 9 | accelerate company processes through standardization and access to information 10 | and data. A special focus is also on SMEs, whose active participation is of 11 | central importance for the network's success. That is why Catena-X has been 12 | conceived from the outset as an open network with solutions ready for SMEs, 13 | where these companies will be able to participate quickly and with little IT 14 | infrastructure investment. Tractus-X is meant to be the PoC project of the 15 | Catena-X alliance focusing on parts traceability. 16 | 17 | * https://projects.eclipse.org/projects/automotive.tractusx 18 | 19 | ## Project licenses 20 | 21 | The Tractus-X project uses the following licenses: 22 | 23 | * Apache-2.0 for code 24 | * CC-BY-4.0 for non-code 25 | 26 | ## Terms of Use 27 | 28 | This repository is subject to the Terms of Use of the Eclipse Foundation 29 | 30 | * https://www.eclipse.org/legal/termsofuse.php 31 | 32 | ## Developer resources 33 | 34 | Information regarding source code management, builds, coding standards, and 35 | more. 36 | 37 | * https://projects.eclipse.org/projects/automotive.tractusx/developer 38 | 39 | Getting started: 40 | 41 | * https://eclipse-tractusx.github.io/docs/developer 42 | 43 | The project maintains the following source code repositories 44 | 45 | * https://github.com/eclipse-tractusx/tractus-x-release 46 | 47 | ## Eclipse Development Process 48 | 49 | This Eclipse Foundation open project is governed by the Eclipse Foundation 50 | Development Process and operates under the terms of the Eclipse IP Policy. 51 | 52 | * https://eclipse.org/projects/dev_process 53 | * https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf 54 | 55 | ## Eclipse Contributor Agreement 56 | 57 | In order to be able to contribute to Eclipse Foundation projects you must 58 | electronically sign the Eclipse Contributor Agreement (ECA). 59 | 60 | * http://www.eclipse.org/legal/ECA.php 61 | 62 | The ECA provides the Eclipse Foundation with a permanent record that you agree 63 | that each of your contributions will comply with the commitments documented in 64 | the Developer Certificate of Origin (DCO). Having an ECA on file associated with 65 | the email address matching the "Author" field of your contribution's Git commits 66 | fulfills the DCO's requirement that you sign-off on your contributions. 67 | 68 | For more information, please see the Eclipse Committer Handbook: 69 | https://www.eclipse.org/projects/handbook/#resources-commit 70 | 71 | ## Contact 72 | 73 | Contact the project developers via the project's "dev" list. 74 | 75 | * https://accounts.eclipse.org/mailing-list/tractusx-dev 76 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Community Code of Conduct 2 | 3 | **Version 2.0 4 | January 1, 2023** 5 | 6 | ## Our Pledge 7 | 8 | In the interest of fostering an open and welcoming environment, we as community members, contributors, Committers[^1], and Project Leads (collectively "Contributors") pledge to make participation in our projects and our community a harassment-free and inclusive experience for everyone. 9 | 10 | This Community Code of Conduct ("Code") outlines our behavior expectations as members of our community in all Eclipse Foundation activities, both offline and online. It is not intended to govern scenarios or behaviors outside of the scope of Eclipse Foundation activities. Nor is it intended to replace or supersede the protections offered to all our community members under the law. Please follow both the spirit and letter of this Code and encourage other Contributors to follow these principles into our work. Failure to read or acknowledge this Code does not excuse a Contributor from compliance with the Code. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contribute to creating a positive and professional environment include: 15 | 16 | - Using welcoming and inclusive language; 17 | - Actively encouraging all voices; 18 | - Helping others bring their perspectives and listening actively. If you find yourself dominating a discussion, it is especially important to encourage other voices to join in; 19 | - Being respectful of differing viewpoints and experiences; 20 | - Gracefully accepting constructive criticism; 21 | - Focusing on what is best for the community; 22 | - Showing empathy towards other community members; 23 | - Being direct but professional; and 24 | - Leading by example by holding yourself and others accountable 25 | 26 | Examples of unacceptable behavior by Contributors include: 27 | 28 | - The use of sexualized language or imagery; 29 | - Unwelcome sexual attention or advances; 30 | - Trolling, insulting/derogatory comments, and personal or political attacks; 31 | - Public or private harassment, repeated harassment; 32 | - Publishing others' private information, such as a physical or electronic address, without explicit permission; 33 | - Violent threats or language directed against another person; 34 | - Sexist, racist, or otherwise discriminatory jokes and language; 35 | - Posting sexually explicit or violent material; 36 | - Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history; 37 | - Personal insults, especially those using racist or sexist terms; 38 | - Excessive or unnecessary profanity; 39 | - Advocating for, or encouraging, any of the above behavior; and 40 | - Other conduct which could reasonably be considered inappropriate in a professional setting 41 | 42 | ## Our Responsibilities 43 | 44 | With the support of the Eclipse Foundation employees, consultants, officers, and directors (collectively, the "Staff"), Committers, and Project Leads, the Eclipse Foundation Conduct Committee (the "Conduct Committee") is responsible for clarifying the standards of acceptable behavior. The Conduct Committee takes appropriate and fair corrective action in response to any instances of unacceptable behavior. 45 | 46 | ## Scope 47 | 48 | This Code applies within all Project, Working Group, and Interest Group spaces and communication channels of the Eclipse Foundation (collectively, "Eclipse spaces"), within any Eclipse-organized event or meeting, and in public spaces when an individual is representing an Eclipse Foundation Project, Working Group, Interest Group, or their communities. Examples of representing a Project or community include posting via an official social media account, personal accounts, or acting as an appointed representative at an online or offline event. Representation of Projects, Working Groups, and Interest Groups may be further defined and clarified by Committers, Project Leads, or the Staff. 49 | 50 | ## Enforcement 51 | 52 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via conduct@eclipse-foundation.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately. 53 | 54 | Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping. 55 | 56 | Any Staff (including officers and directors of the Eclipse Foundation), Committers, Project Leads, or Conduct Committee members who are the subject of a complaint to the Conduct Committee will be recused from the process of resolving any such complaint. 57 | 58 | ## Responsibility 59 | 60 | The responsibility for administering this Code rests with the Conduct Committee, with oversight by the Executive Director and the Board of Directors. For additional information on the Conduct Committee and its process, please write to . 61 | 62 | ## Investigation of Potential Code Violations 63 | 64 | All conflict is not bad as a healthy debate may sometimes be necessary to push us to do our best. It is, however, unacceptable to be disrespectful or offensive, or violate this Code. If you see someone engaging in objectionable behavior violating this Code, we encourage you to address the behavior directly with those involved. If for some reason, you are unable to resolve the matter or feel uncomfortable doing so, or if the behavior is threatening or harassing, please report it following the procedure laid out below. 65 | 66 | Reports should be directed to . It is the Conduct Committee’s role to receive and address reported violations of this Code and to ensure a fair and speedy resolution. 67 | 68 | The Eclipse Foundation takes all reports of potential Code violations seriously and is committed to confidentiality and a full investigation of all allegations. The identity of the reporter will be omitted from the details of the report supplied to the accused. Contributors who are being investigated for a potential Code violation will have an opportunity to be heard prior to any final determination. Those found to have violated the Code can seek reconsideration of the violation and disciplinary action decisions. Every effort will be made to have all matters disposed of within 60 days of the receipt of the complaint. 69 | 70 | ## Actions 71 | Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee. 72 | 73 | This Code does not address all conduct. It works in conjunction with our [Communication Channel Guidelines](https://www.eclipse.org/org/documents/communication-channel-guidelines/), [Social Media Guidelines](https://www.eclipse.org/org/documents/social_media_guidelines.php), [Bylaws](https://www.eclipse.org/org/documents/eclipse-foundation-be-bylaws-en.pdf), and [Internal Rules](https://www.eclipse.org/org/documents/ef-be-internal-rules.pdf) which set out additional protections for, and obligations of, all contributors. The Foundation has additional policies that provide further guidance on other matters. 74 | 75 | It’s impossible to spell out every possible scenario that might be deemed a violation of this Code. Instead, we rely on one another’s good judgment to uphold a high standard of integrity within all Eclipse Spaces. Sometimes, identifying the right thing to do isn’t an easy call. In such a scenario, raise the issue as early as possible. 76 | 77 | ## No Retaliation 78 | 79 | The Eclipse community relies upon and values the help of Contributors who identify potential problems that may need to be addressed within an Eclipse Space. Any retaliation against a Contributor who raises an issue honestly is a violation of this Code. That a Contributor has raised a concern honestly or participated in an investigation, cannot be the basis for any adverse action, including threats, harassment, or discrimination. If you work with someone who has raised a concern or provided information in an investigation, you should continue to treat the person with courtesy and respect. If you believe someone has retaliated against you, report the matter as described by this Code. Honest reporting does not mean that you have to be right when you raise a concern; you just have to believe that the information you are providing is accurate. 80 | 81 | False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated. 82 | 83 | Everyone is encouraged to ask questions about this Code. Your feedback is welcome, and you will get a response within three business days. Write to . 84 | 85 | ## Amendments 86 | 87 | The Eclipse Foundation Board of Directors may amend this Code from time to time and may vary the procedures it sets out where appropriate in a particular case. 88 | 89 | ### Attribution 90 | 91 | This Code was inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/). 92 | 93 | [^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws. 94 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /tools/sanity-check/README.md: -------------------------------------------------------------------------------- 1 | # Capability 2 | 3 | This tool can accomplish the following sanity checks for tables in a specified release of a Changelog 4 | 5 | Link checks: 6 | 7 | - KIT 8 | - Eclipse-Tractus-X Link 9 | - Github Changelog 10 | - FOSS 11 | - release / repo link 12 | - chart link 13 | - release link in GitHub for apps of chart 14 | 15 | Version checks (FOSS only): 16 | 17 | - check that chart has been released 18 | - check that helm repo version == given version 19 | - check that app version is same for all apps of chart 20 | 21 | **Out of scope**: Check inline links in the text. 22 | 23 | # Usage 24 | 25 | ## Prerequisites 26 | 27 | You need the following tools installed 28 | - [python3 (I used python3.10)](https://www.python.org/downloads/) 29 | - [venv](https://docs.python.org/3/library/venv.html) 30 | 31 | Create a venv based on requirements.txt (note: you could also just install the requirements.txt but that is 32 | REALLY BAD PRACTICE). 33 | 34 | ```shell 35 | pip install --upgrade virtualenv 36 | # outputs where your virtualenv script lies or adds it to path 37 | # WARNING: The script virtualenv is installed in '/home/user/.local/bin' which is not on PATH. 38 | # Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location. 39 | 40 | # add to path or just use path as above 41 | path/to/virtualenv venv 42 | # creates 'venv' folder 43 | 44 | # activate venv 45 | source venv/bin/activate 46 | # shell is prefixed with '(venv)' 47 | 48 | # install dependencies 49 | pip install -r requirements.txt 50 | ``` 51 | 52 | ## Actual usage 53 | 54 | Run for a CHANGELOG.md and a release as follows: 55 | 56 | ```shell 57 | cd tools/sanity-check 58 | 59 | # enter venv (linux, see https://docs.python.org/3/library/venv.html#how-venvs-work) 60 | source venv/bin/activate 61 | 62 | # run command 63 | python3 check.py ../CHANGLEOG.md 24.05 64 | ``` 65 | 66 | Sample outputs for a run for R24.03 close to R24.05. Please note that it fails for incorrect structure as it can not 67 | substring needed information correctly (trace-x chart name missing). 68 | 69 | ``` 70 | Found 8 releases 71 | Extracting tables for release: 24.03 72 | Release consists of 103 lines 73 | 74 | Processing table 'Added' 75 | Checking LINKS for KIT: Certificate Management KIT 76 | Checking LINKS for KIT: Data Governance KIT 77 | Checking LINKS for KIT: Environmental and Social Standards (ESS) KIT 78 | Checking LINKS for KIT: Industry Core KIT 79 | Checking LINKS for KIT: Manufacturing as a Service (MaaS) KIT 80 | Checking LINKS for FOSS Component: PURIS 81 | Checking CHART for FOSS Component: PURIS 82 | ERROR: Chart version of FOSS Chart puris has version 1.0.0 while version 2.6.0 is available in tractusx-dev 83 | ERROR: App version of FOSS Chart puris (app PURIS) has app version 1.0.0 while version 2.0.0 is set in Chart available in tractusx-dev 84 | 85 | 86 | Processing table 'Updated' 87 | Checking LINKS for KIT: Business Partner KIT 88 | Checking LINKS for KIT: Connector KIT 89 | Multiline APPs for FOSS Component Country Risk 90 | Checking LINKS for FOSS Component: Country Risk 91 | Checking CHART for FOSS Component: Country Risk 92 | ERROR: Chart version of FOSS Chart country-risk has version 3.0.11 while version 4.0.2 is available in tractusx-dev 93 | ERROR: App version of FOSS Chart country-risk (app Frontend) has app version 1.3.1 while version 2.0.0 is set in Chart available in tractusx-dev 94 | ERROR: App version of FOSS Chart country-risk (app Backend) has app version 1.3.1 while version 2.0.0 is set in Chart available in tractusx-dev 95 | Checking LINKS for KIT: Demand and Capacity Management (DCM) KIT 96 | Checking LINKS for FOSS Component: Digital Product Pass (DPP) 97 | Checking CHART for FOSS Component: Digital Product Pass (DPP) 98 | ERROR: Chart version of FOSS Chart digital-product-pass has version 2.1.4 while version 3.0.0 is available in tractusx-dev 99 | ERROR: App version of FOSS Chart digital-product-pass (app Digital Product Pass (DPP)) has app version v2.1.3 while version 3.0.0 is set in Chart available in tractusx-dev 100 | Checking LINKS for KIT: Digital Twin KIT 101 | Checking LINKS for FOSS Component: Digital Twin Registry 102 | Checking CHART for FOSS Component: Digital Twin Registry 103 | ERROR: Chart version of FOSS Chart digital-twin-registry has version 0.3.31 while version 0.4.11 is available in tractusx-dev 104 | ERROR: App version of FOSS Chart digital-twin-registry (app Digital Twin Registry) has app version v0.3.23 while version 0.4.3 is set in Chart available in tractusx-dev 105 | Checking LINKS for FOSS Component: Discovery Finder 106 | Checking CHART for FOSS Component: Discovery Finder 107 | ERROR: Chart version of FOSS Chart discoveryfinder has version 0.1.18 while version 0.2.5 is available in tractusx-dev 108 | ERROR: App version of FOSS Chart discoveryfinder (app Discovery Finder) has app version v0.2.7 while version 0.3.1 is set in Chart available in tractusx-dev 109 | Checking LINKS for FOSS Component: Discovery Service (BPN Finder) 110 | Checking CHART for FOSS Component: Discovery Service (BPN Finder) 111 | ERROR: Chart version of FOSS Chart bpndiscovery has version 0.1.18 while version 0.2.6 is available in tractusx-dev 112 | ERROR: App version of FOSS Chart bpndiscovery (app Discovery Service (BPN Finder)) has app version 0.2.8 while version 0.3.1 is set in Chart available in tractusx-dev 113 | Checking LINKS for FOSS Component: Eclipse Data Space Connector (EDC) 114 | Checking CHART for FOSS Component: Eclipse Data Space Connector (EDC) 115 | ERROR: Chart version of FOSS Chart tractusx-connector has version 0.5.4 while version 0.7.2 is available in tractusx-dev 116 | ERROR: App version of FOSS Chart tractusx-connector (app Eclipse Data Space Connector (EDC)) has app version 0.5.4 while version 0.7.2 is set in Chart available in tractusx-dev 117 | Checking LINKS for KIT: Eco Pass KIT 118 | Checking LINKS for FOSS Component: Golden Record Business Partner Number (BPN) Service 119 | Checking CHART for FOSS Component: Golden Record Business Partner Number (BPN) Service 120 | ERROR: Chart version of FOSS Chart bpdm has version 4.0.2 while version 5.0.0 is available in tractusx-dev 121 | ERROR: App version of FOSS Chart bpdm (app Golden Record Business Partner Number (BPN) Service) has app version v5.0.0 while version 6.0.0 is set in Chart available in tractusx-dev 122 | Checking LINKS for FOSS Component: Item Relationship Service (IRS) 123 | Checking CHART for FOSS Component: Item Relationship Service (IRS) 124 | ERROR: Chart version of FOSS Chart irs-helm has version 6.14.1 while version 6.18.0 is available in tractusx-dev 125 | ERROR: App version of FOSS Chart irs-helm (app Item Relationship Service (IRS)) has app version 4.5.1 while version 4.9.0 is set in Chart available in tractusx-dev 126 | Checking LINKS for FOSS Component: Knowledge Agents 127 | Checking CHART for FOSS Component: Knowledge Agents 128 | ERROR: Chart version of FOSS Chart remoting-agent has version 1.11.16 while version 1.12.19 is available in tractusx-dev 129 | ERROR: App version of FOSS Chart remoting-agent (app Knowledge Agents) has app version 1.11.16 while version 1.12.19 is set in Chart available in tractusx-dev 130 | Checking LINKS for KIT: Knowledge Agents KIT 131 | Checking LINKS for FOSS Component: Managed Identity Wallet (MIW) 132 | Checking CHART for FOSS Component: Managed Identity Wallet (MIW) 133 | ERROR: Chart version of FOSS Chart managed-identity-wallet has version 0.3.0 while version 0.4.0 is available in tractusx-dev 134 | ERROR: App version of FOSS Chart managed-identity-wallet (app Managed Identity Wallet (MIW)) has app version 0.3.0 while version 0.4.0 is set in Chart available in tractusx-dev 135 | Checking LINKS for FOSS Component: Managed Service Orchestrator 136 | Checking CHART for FOSS Component: Managed Service Orchestrator 137 | ERROR: Chart version of FOSS Chart managed-service-orchestrator has version 1.5.4 while version 1.5.8 is available in tractusx-dev 138 | ERROR: App version of FOSS Chart managed-service-orchestrator (app Managed Service Orchestrator) has app version v1.5.4 while version 1.5.5 is set in Chart available in tractusx-dev 139 | Checking LINKS for KIT: OSim KIT 140 | Checking LINKS for FOSS Component: Policy Hub 141 | Checking CHART for FOSS Component: Policy Hub 142 | ERROR: Chart version of FOSS Chart policy-hub has version 0.1.0 while version 1.0.0 is available in tractusx-dev 143 | ERROR: App version of FOSS Chart policy-hub (app Policy Hub) has app version 0.1.0 while version 1.0.0 is set in Chart available in tractusx-dev 144 | Multiline APPs for FOSS Component Portal 145 | Checking LINKS for FOSS Component: Portal 146 | Checking CHART for FOSS Component: Portal 147 | ERROR: Chart version of FOSS Chart portal has version 1.8.0 while version 1.8.1 is available in tractusx-dev 148 | ERROR: App version of FOSS Chart portal (app Registration) has app version 1.6.0 while version 1.8.1 is set in Chart available in tractusx-dev 149 | ERROR: App version of FOSS Chart portal (app Frontend) has app version 1.8.0 while version 1.8.1 is set in Chart available in tractusx-dev 150 | ERROR: App version of FOSS Chart portal (app Backend) has app version 1.8.0 while version 1.8.1 is set in Chart available in tractusx-dev 151 | ERROR: App version of FOSS Chart portal (app Assets) has app version 1.8.0 while version 1.8.1 is set in Chart available in tractusx-dev 152 | Checking LINKS for KIT: Product Carbon Footprint (PCF) KIT 153 | Checking LINKS for KIT: Quality KIT 154 | Checking LINKS for FOSS Component: Self Description (SD) Factory 155 | Checking CHART for FOSS Component: Self Description (SD) Factory 156 | ERROR: Chart version of FOSS Chart sdfactory has version 2.1.12 while version 2.1.19 is available in tractusx-dev 157 | ERROR: App version of FOSS Chart sdfactory (app Self Description (SD) Factory) has app version v2.1.10 while version 2.1.12 is set in Chart available in tractusx-dev 158 | Multiline APPs for FOSS Component Simple Data Exchanger (SDE) 159 | Checking LINKS for FOSS Component: Simple Data Exchanger (SDE) 160 | Checking CHART for FOSS Component: Simple Data Exchanger (SDE) 161 | ERROR: Chart version of FOSS Chart sde has version 0.1.5 while version 0.1.8 is available in tractusx-dev 162 | ERROR: App version of FOSS Chart sde (app Frontend) has app version 2.3.6 while version 2.4.0 is set in Chart available in tractusx-dev 163 | ERROR: App version of FOSS Chart sde (app Backend) has app version 2.3.6 while version 2.4.0 is set in Chart available in tractusx-dev 164 | Checking LINKS for FOSS Component: Semantic Hub 165 | Checking CHART for FOSS Component: Semantic Hub 166 | ERROR: Chart version of FOSS Chart semantic-hub has version 0.1.35 while version 0.2.3 is available in tractusx-dev 167 | ERROR: App version of FOSS Chart semantic-hub (app Semantic Hub) has app version v0.2.16 while version 0.3.2 is set in Chart available in tractusx-dev 168 | Checking LINKS for FOSS Component: Trace-X Traceability Application 169 | Checking CHART for FOSS Component: Trace-X Traceability Application 170 | ERROR: Could not retrieve latest Helm chart or app version for [1.3.28](https. 171 | ERROR: Chart version of FOSS Chart [1.3.28](https has version 1.3.28 while version None is available in tractusx-dev 172 | ERROR: App version of FOSS Chart [1.3.28](https (app Trace-X Traceability Application) has app version 10.3.0 while version None is set in Chart available in tractusx-dev 173 | Checking LINKS for KIT: Traceability KIT 174 | 175 | 176 | Processing table 'Unchanged, untested' 177 | Checking LINKS for KIT: Behavioral Twin: Health Indicators (HI) KIT 178 | Checking LINKS for KIT: Behavioral Twin: Model and Data processing (MDP) KIT 179 | Checking LINKS for KIT: Behavioral Twin: Remaining useful Life (RUL) KIT 180 | Checking LINKS for KIT: Circularity KIT 181 | Checking LINKS for KIT: Modular Production KIT 182 | ``` 183 | 184 | # DEPENDENCY update 185 | 186 | You can check dependencies for python using eclipse dash tool as follows: 187 | 188 | Download latest version of dash [here](https://github.com/eclipse/dash-licenses/tags) 189 | 190 | ```shell 191 | # move to a persistent folder. Could also be ~/jars. 192 | mv org.eclipse.dash.licenses-1.1.0.jar ~/coding/org.eclipse.dash.licenses-1.1.0.jar 193 | vim ~/.bashrc 194 | # add following line using i 195 | alias eclipseDashTool='java -jar ~/coding/org.eclipse.dash.licenses-1.1.0.jar' 196 | # esc, qw -> enter to save and exit 197 | source ~/.bashrc 198 | # cd to directory containing the requirements.txt 199 | cd tools/sanity-check 200 | 201 | cat requirements.txt | grep -v \# \ 202 | | sed -E -e 's|([^= ]+)==([^= ]+)|pypi/pypi/-/\1/\2|' -e 's| ||g' \ 203 | | sort | uniq \ 204 | | eclipseDashTool -project automotive.tractusx -summary ./DEPENDENCIES - 205 | ``` 206 | -------------------------------------------------------------------------------- /tools/sanity-check/check.py: -------------------------------------------------------------------------------- 1 | # ############################################################################# 2 | # Copyright (c) 2024 Contributors to the Eclipse Foundation 3 | # 4 | # See the NOTICE file(s) distributed with this work for additional 5 | # information regarding copyright ownership. 6 | # 7 | # This program and the accompanying materials are made available under the 8 | # terms of the Apache License, Version 2.0 which is available at 9 | # https://www.apache.org/licenses/LICENSE-2.0. 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 | # License for the specific language governing permissions and limitations 15 | # under the License. 16 | # 17 | # SPDX-License-Identifier: Apache-2.0 18 | # ############################################################################# 19 | 20 | import requests 21 | import subprocess 22 | import pandas as pd 23 | from pathlib import Path 24 | import sys 25 | 26 | """ 27 | Walks through a table row-wise and extracts it either as a KIT or FOSS component into a dict for easier processing 28 | 29 | Example FOSS component: 30 | { 31 | 'type': 'FOSS', 32 | 'type_name': 'Country Risk', 33 | 'type_link': 'https://github.com/eclipse-tractusx/vas-country-risk', 34 | 'chart': { 35 | 'name': 'country-risk', 36 | 'version': '3.0.11', 37 | 'link': '3.0.11' 38 | }, 39 | 'apps': [ 40 | { 41 | 'name': 'Frontend', 42 | 'version': 'v1.3.1', 43 | 'link': 'https://github.com/eclipse-tractusx/vas-country-risk/releases/tag/v1.3.1' 44 | }, { 45 | 'name': 'Backend', 46 | 'version': 'v1.3.1', 47 | 'link': 'https://github.com/eclipse-tractusx/vas-country-risk-backend/releases/tag/v1.3.1' 48 | } 49 | ] 50 | } 51 | 52 | Example KIT: 53 | { 54 | 'type': 'KIT', 55 | 'type_name': 'Digital Twin KIT', 56 | 'type_link': 'https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit', 57 | 'kit': { 58 | 'version': '1.2.0', 59 | 'link': 'https://eclipse-tractusx.github.io/docs-kits/kits/Digital%20Twin%20Kit/Digital%20Twin%20Kit%20Changelog' 60 | } 61 | } 62 | """ 63 | def transform_row_to_dict(row): 64 | component_name = row['Component'].strip().split(']')[0][1:] 65 | helm_chart = row['Helm Chart (s)'] 66 | 67 | component_link = row['Component'].strip().split(']')[1][1:-1] 68 | 69 | # sample Frontend: [v1.3.1](https://link-to-version)
Backend: [v1.3.1](https://link-to-version) 70 | app_kit_line = row['App-/KIT Version (s)'].strip() 71 | app_kit_array = [] 72 | if "
" in app_kit_line: 73 | print(f"Multiline APPs for FOSS Component {component_name}") 74 | for app in app_kit_line.split("
"): 75 | # portal has double br, skip empty line 76 | if len(app.strip()) == 0: 77 | continue 78 | name = app.strip().split(":")[0] 79 | version = app[app.index("[") + 1:app.index("]")] 80 | version = version[1:] if version[0] == "v" else version 81 | link = app[app.index("(") + 1:app.index(")")] 82 | app_kit_array.append({ 83 | "name": name, 84 | "version": version, 85 | "link": link 86 | }) 87 | else: 88 | version = app_kit_line[app_kit_line.index("[") + 1:app_kit_line.index("]")] 89 | link = app_kit_line[app_kit_line.index("(") + 1:app_kit_line.index(")")] 90 | app_kit_array.append({ 91 | "name": component_name, 92 | "version": version, 93 | "link": link 94 | }) 95 | 96 | type = "KIT" if "n/a" in helm_chart else "FOSS" 97 | 98 | # Extract chart name and version if available 99 | if type == "FOSS": 100 | chart_name = helm_chart.split(':')[0].strip() 101 | chart_version = helm_chart[helm_chart.index("[") + 1:helm_chart.index("]")].strip() 102 | chart_version_link = helm_chart.split('(')[-1].split(')')[0].strip() 103 | return { 104 | "type": type, 105 | "type_name": component_name, 106 | "type_link": component_link, 107 | "chart": { 108 | "name": chart_name, 109 | "version": chart_version, 110 | "link": chart_version_link 111 | }, 112 | "apps": app_kit_array 113 | } 114 | else: 115 | return { 116 | "type": type, 117 | "type_name": component_name, 118 | "type_link": component_link, 119 | "kit": app_kit_array[0] 120 | } 121 | 122 | 123 | """ 124 | Returns true if link request results in a 200er, else false 125 | 126 | Allows redirects 127 | """ 128 | def check_link(url): 129 | try: 130 | # follow redirects as eclipse-tractusx.github.io redirects 131 | response = requests.head(url, allow_redirects=True) 132 | 133 | status_code = response.status_code 134 | # print(f"Status code: {status_code}") 135 | return 200 <= status_code < 300 136 | except requests.RequestException: 137 | print(f"ERROR: {url}, {requests.RequestException}") 138 | return False 139 | 140 | 141 | """ 142 | Extracts latest chart and app version for chart. 143 | 144 | chart_name without prefix "tractusx-dev/" 145 | 146 | We only take the latest. If there are different charts that start with the same name, we only use the first overall 147 | chart (it's the chart_name). 148 | """ 149 | def determine_latest_versions_for_chart(chart_name): 150 | # if rc and so on would be needed --devel 151 | helm_search = subprocess.run( 152 | ["helm", "search", "repo", f"tractusx-dev/{chart_name}", "--versions"], 153 | capture_output=True, 154 | text=True 155 | ) 156 | latest_chart_version = None 157 | latest_app_version = None 158 | 159 | if helm_search.returncode == 0: 160 | output_lines = helm_search.stdout.splitlines() 161 | 162 | # > 1 needed due to header (NAME, CHART VERSION, APP VERSION) 163 | if len(output_lines) > 1: 164 | latest_chart_version = output_lines[1].split("\t")[1].strip() 165 | latest_app_version = output_lines[1].split("\t")[2].strip() 166 | return latest_chart_version, latest_app_version 167 | 168 | 169 | """ 170 | Checks all links for the KIT to be working 171 | 172 | Checks following links: 173 | - Eclipse-Tractus-X Link 174 | - Github Changelog 175 | """ 176 | def check_links_kit(parsed_row): 177 | print(f"Checking LINKS for {parsed_row['type']}: {parsed_row['type_name']}") 178 | 179 | # Eclipse-Tractus-X link 180 | if not check_link(parsed_row['type_link']): 181 | print(f" ERROR: KIT {parsed_row['type_name']} has invalid link '{parsed_row['type_link']}'") 182 | 183 | # github changelog 184 | if not check_link(parsed_row['kit']['link']): 185 | print(f" ERROR: Changelog of KIT {parsed_row['type_name']} has invalid link '{parsed_row['kit']['link']}'") 186 | 187 | 188 | """ 189 | Checks all links for the FOSS to be working 190 | 191 | Checks following links: 192 | - release / repo link 193 | - chart link 194 | - release link in github for apps of chart 195 | """ 196 | def check_links_foss(parsed_row): 197 | print(f"Checking LINKS for {parsed_row['type']} Component: {parsed_row['type_name']}") 198 | 199 | # release 200 | if not check_link(parsed_row['type_link']): 201 | print(f" ERROR: FOSS {parsed_row['type_name']} has invalid link '{parsed_row['type_link']}'") 202 | 203 | # chart 204 | chart = parsed_row['chart'] 205 | if not check_link(chart['link']): 206 | print(f" ERROR: Release of FOSS Chart {chart['name']} has invalid link '{chart['link']}'") 207 | if not chart['link'].endswith(chart['version']): 208 | print( 209 | f" ERROR: Release version '{chart['version']}' and link version '{chart['link']}' of FOSS Chart {chart['name']} do not match") 210 | 211 | # apps 212 | for app in parsed_row['apps']: 213 | if not check_link(app['link']): 214 | print(f" ERROR: Release of FOSS APP {app['name']} has invalid link '{app['link']}'") 215 | if not app['link'].endswith(app['version']): 216 | print( 217 | f" ERROR: Release version '{app['version']}' and link version '{app['link']}' of FOSS APP {app['name']} do not match") 218 | 219 | 220 | """ 221 | Determines latest chart and app version from Chart and cross-checks 222 | 223 | Performs following checks: 224 | - check that chart has been released 225 | - check that helm repo version == given version 226 | - check that app version is same for all apps of chart 227 | """ 228 | def check_chart_versions_repo_foss(parsed_row): 229 | print(f"Checking CHART for {parsed_row['type']} Component: {parsed_row['type_name']}") 230 | 231 | chart = parsed_row['chart'] 232 | # Check if Helm chart and app version are latest 233 | latest_chart_version, latest_app_version = determine_latest_versions_for_chart(chart["name"]) 234 | if not (latest_chart_version and latest_app_version): 235 | print(f" ERROR: Could not retrieve latest Helm chart or app version for {chart['name']}.") 236 | 237 | if latest_chart_version != chart["version"]: 238 | print( 239 | f" ERROR: Chart version of FOSS Chart {chart['name']} has version {chart['version']} while version {latest_chart_version} is available in tractusx-dev") 240 | 241 | for app in parsed_row['apps']: 242 | # normalize as apps in GitHub may start with v but list output of helm search is always without v 243 | # only use for comparison so that during check we know not to false-positive correct the GitHub app link 244 | normalized_app_version = app["version"].lstrip('v') 245 | if latest_app_version != normalized_app_version: 246 | print( 247 | f" ERROR: App version of FOSS Chart {chart['name']} (app {app['name']}) has app version {app['version']} while version {latest_app_version} is set in Chart available in tractusx-dev") 248 | 249 | 250 | """ 251 | Performs the actual checks: 252 | 253 | KIT: check only links are working 254 | FOSS: 255 | - check links are working 256 | - check versions are correct (latest used, links contain correct version) 257 | """ 258 | def check_table(df): 259 | for index, row in df.iterrows(): 260 | 261 | parsed_row = transform_row_to_dict(row) 262 | 263 | if parsed_row["type"] == 'KIT': 264 | check_links_kit(parsed_row) 265 | else: 266 | check_links_foss(parsed_row) 267 | check_chart_versions_repo_foss(parsed_row) 268 | 269 | 270 | """ 271 | Transforms table data to a data frame 272 | 273 | - data must be lines of data each still containing the table limiters "|" 274 | - we expect exactly 3 columns per table (Component, Helm Chart (s), App-/KIT Version (s) 275 | """ 276 | def get_table_as_df(data): 277 | data = [line.strip("|").split("|") for line in data if line.strip()] 278 | for line in data: 279 | assert len(line) == 3, f"line {line} has wrong length {len(line)}, but we expect 3" 280 | headers = [header.strip() for header in data[0]] 281 | # skip headers and format line with "|---|---|..." 282 | df = pd.DataFrame(data[2:], columns=headers) 283 | return df 284 | 285 | 286 | """ 287 | Returns list of tuple (table heading, table as df) 288 | 289 | - Finds heading via h3 (###) 290 | - Identifies tables via starting with | and having further | in line 291 | """ 292 | def extract_tables_as_dfs(release_content): 293 | lines = release_content.split('\n') 294 | tables = [] 295 | table_heading = "" 296 | table_data = [] 297 | in_table = False 298 | 299 | print(f"Release consists of {len(lines)} lines") 300 | 301 | for line in lines: 302 | if line.startswith("###"): 303 | table_heading = line[4:].strip() 304 | if line.strip().startswith('|') and '|' in line: 305 | in_table = True 306 | table_data.append(line) 307 | else: 308 | if in_table: 309 | if len(table_data) > 0: 310 | df = get_table_as_df(table_data) 311 | tables.append((table_heading, df)) 312 | table_data = [] 313 | in_table = False 314 | 315 | # Process the last table if the file ends while still in a table 316 | if in_table and table_data: 317 | [print(line) for line in table_data] 318 | df = get_table_as_df(table_data) 319 | tables.append((table_heading, df)) 320 | 321 | return tables 322 | 323 | 324 | """ 325 | Extracts tables from markdown file for a release_of_interest 326 | 327 | Currently the links or similar outside the table are not considered 328 | """ 329 | def extract_tables_for_release(file_path, release_of_interest): 330 | with open(file_path, 'r') as file: 331 | content = file.read() 332 | 333 | # results in n +1 releases as there is one chunk prior to the first release heading 334 | releases = content.split('## [')[1:] 335 | print(f"Found {len(releases)} releases") 336 | tables = [] 337 | for release in releases: 338 | # Heading till link [ has already been already substringed 339 | release_name = release.split(']')[0].strip() 340 | if release_name == release_of_interest: 341 | # release_content = release.split(']')[1] 342 | print(f"Extracting tables for release: {release_name}") 343 | tables = extract_tables_as_dfs(release) 344 | return tables 345 | 346 | return tables 347 | 348 | 349 | """ 350 | Extracts tables from markdown file to check for working links and version mismatches 351 | 352 | Updates tractusx-dev helm chart repository to check chart versions 353 | """ 354 | def main(): 355 | if len(sys.argv) > 1: 356 | file_path = Path(sys.argv[1]) 357 | release_of_interest = sys.argv[2] 358 | else: 359 | print("Please use as follows: python relative-path/CHANGELOG.md 24.05") 360 | exit(-1) 361 | 362 | df_tables = extract_tables_for_release(file_path, release_of_interest) 363 | 364 | if len(df_tables) == 0: 365 | print(f"No tables found for release {release_of_interest} in file {file_path}") 366 | exit(0) 367 | 368 | # Helm repository setup 369 | subprocess.run(["helm", "repo", "add", "tractusx-dev", "https://eclipse-tractusx.github.io/charts/dev"], 370 | capture_output=True) 371 | subprocess.run(["helm", "repo", "update"], capture_output=True) 372 | 373 | for table_heading, df in df_tables: 374 | print(f"\nProcessing table '{table_heading}'") 375 | check_table(df) 376 | print() 377 | 378 | 379 | if __name__ == "__main__": 380 | main() 381 | -------------------------------------------------------------------------------- /LICENSE_non-code: -------------------------------------------------------------------------------- 1 | Creative Commons Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | --------------------------------------------------------------------------------