admin-shell-io · juileetikekar · May 27, 2025 · Nov 16, 2023 · Nov 16, 2023 · Nov 16, 2023
diff --git a/.github/workflows/check-changed-files.yml b/.github/workflows/check-changed-files.yml
@@ -0,0 +1,36 @@
+name: Check-changed-files
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  actions: read
+
+jobs:
+  qodana:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: ${{ github.event.pull_request.commits }}
+
+      - name: Get two more commits so Qodana we can identify the changes
+        if: github.event_name == 'pull_request'
+        run: git fetch --deepen=2
+
+      - name: Run Qodana inspection
+        uses: JetBrains/qodana-action@v2024.3.4
+        with:
+          upload-result: true
+          args: >
+            --baseline,doc/qodana-baseline.sarif.json,
+            --config,.qodana/qodana.yaml
+
+      # This step uploads the SARIF file to GitHub so that the code scanning feature can use it.
+      # https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#example-workflow-that-runs-the-eslint-analysis-tool
+      - name: Upload SARIF report to GitHub
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+################################################################################
+# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
+################################################################################
+
+/.vs
diff --git a/.qodana/asciidoc-inspection.xml b/.qodana/asciidoc-inspection.xml
@@ -0,0 +1,29 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0" is_locked="true">
+    <!-- GrazieInspection normally has a TYPO preference -->
+    <inspection_tool class="GrazieInspection" enabled="true" level="WARNING" enabled_by_default="true"/>
+    <inspection_tool class="AsciiDocAnchorWithoutId" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocAttributeContinuation" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocBlockMacroShouldBeInlineMacro" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocDescriptionExists" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocDescriptionLength" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocHeadingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocHorizontalRule" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocInlineMacroShouldBeBlockOrPreprocessorMacro" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocLinkResolve" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocListingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocPageBreak" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocReferencePattern" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocXrefWithFileExtension" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocXrefWithNaturalCrossReference" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocAttributeShouldBeDefined" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocObsoletePassthrough" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="AsciiDocUnresolvedAntoraModule" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="SpellCheckingInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="processCode" value="true" />
+      <option name="processLiterals" value="true" />
+      <option name="processComments" value="true" />
+    </inspection_tool>
+    <inspection_tool class="Style" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>
diff --git a/.qodana/qodana.yaml b/.qodana/qodana.yaml
@@ -0,0 +1,20 @@
+version: 1.0
+profile:
+  path: .qodana/asciidoc-inspection.xml
+linter: jetbrains/qodana-jvm-community:2024.3
+plugins:
+  - id: org.asciidoctor.intellij.asciidoc
+
+include:
+  - name: HttpUrlsUsage
+  - name: GrazieInspection
+
+exclude:
+  - name: All
+    paths:
+      - .github
+      - .qodana
+      - CONTRIBUTING.md
+      - LICENSE.txt
+      - README.md
+      - examples
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
+
 # IDTA-01005 Package File Format (AASX)
 
+
 Repository of the Specification of the Asset Administration Shell - Part 5: Package File Format (AASX)
 
 ## Industrial Digital Twin Association (IDTA)
@@ -8,16 +10,36 @@ Governance of the specification is done in the working group **Open Technology**
 
 The specification number is: **IDTA-01005**
 
+
+## Releases
+
+The following versioning scheme is applied: 'V\<major>.\<minor>.\<patch>'. 
+Major versions indicate breaking changes while minor updates are backward compatible.
+The patch position is increased whenever bugfixes need to be applied. 
+The following release contains the latest version of the AAS schemas
+ (see also the [releases](https://github.com/admin-shell-io/aas-specs-aasx/releases) 
+section of this repository):
+
+* [3.1.0](https://github.com/admin-shell-io/aas-specs-aasx/releases/tag/v3.1.0)
+is the latest release for the `V3.1.0` version of the AASX Package File Format, 
+containing the normative sources for the published document
+ "Specification of the Asset Administration Shell: Part 5 -Package File Format (AASX)". 
+
+*Use this release if you want to work with the latest specified AAS version.*
+
+
+
 ## Contributing
 
 Feature requests, reports about inconsistencies, mistakes *etc.* are highly
-welcome! Please [submit a new issue](
-https://github.com/admin-shell-io/aas-specs/issues/new
-).
+welcome! Please [submit a new issue](https://github.com/admin-shell-io/aas-specs-aasx/issues/new).
+
+If you want to contribute, see [CONTRIBUTING.md](https://github.com/admin-shell-io/aas-specs-metamodel/blob/master/CONTRIBUTING.md). 
+The same contribution rules apply as for [aas-specs-metamodel](https://github.com/admin-shell-io/aas-specs-metamodel).
 
-If you want to contribute, see [CONTRIBUTING.md](https://github.com/admin-shell-io/aas-specs/blob/master/CONTRIBUTING.md). The same contribution rules apply as for [aas-specs](https://github.com/admin-shell-io/aas-specs)
 
 ## License
 
 This work is licensed under a [Creative Commons Attribution 4.0 International License](
 https://creativecommons.org/licenses/by/4.0/). 
+
diff --git a/documentation/IDTA-01005/antora.yml b/documentation/IDTA-01005/antora.yml
@@ -0,0 +1,10 @@
+name: IDTA-01005
+
+title: 'Part 5: Package File Format (AASX)'
+version: 'v3.1'
+display_version: 'in progress'
+prerelease: true
+
+start_page: ROOT:index.adoc
+nav:
+  - modules/ROOT/nav.adoc
diff --git a/documentation/IDTA-01005/modules/ROOT/images/aas-info-exchange-types.jpg b/documentation/IDTA-01005/modules/ROOT/images/aas-info-exchange-types.jpg
diff --git a/documentation/IDTA-01005/modules/ROOT/images/aasx-file-structure.png b/documentation/IDTA-01005/modules/ROOT/images/aasx-file-structure.png
diff --git a/documentation/IDTA-01005/modules/ROOT/images/aasx-package-gen-and-use.jpeg b/documentation/IDTA-01005/modules/ROOT/images/aasx-package-gen-and-use.jpeg
diff --git a/documentation/IDTA-01005/modules/ROOT/images/aasx-rels.png b/documentation/IDTA-01005/modules/ROOT/images/aasx-rels.png
diff --git a/documentation/IDTA-01005/modules/ROOT/images/example-info-filter.jpg b/documentation/IDTA-01005/modules/ROOT/images/example-info-filter.jpg
diff --git a/documentation/IDTA-01005/modules/ROOT/images/export-import-filter.jpg b/documentation/IDTA-01005/modules/ROOT/images/export-import-filter.jpg
diff --git a/documentation/IDTA-01005/modules/ROOT/images/file-exchange-two-partners.jpg b/documentation/IDTA-01005/modules/ROOT/images/file-exchange-two-partners.jpg
diff --git a/documentation/IDTA-01005/modules/ROOT/images/image1.png b/documentation/IDTA-01005/modules/ROOT/images/image1.png
diff --git a/documentation/IDTA-01005/modules/ROOT/images/logical-to-physical-map.png b/documentation/IDTA-01005/modules/ROOT/images/logical-to-physical-map.png
diff --git a/documentation/IDTA-01005/modules/ROOT/images/use-case-file-exchange.jpeg b/documentation/IDTA-01005/modules/ROOT/images/use-case-file-exchange.jpeg
diff --git a/documentation/IDTA-01005/modules/ROOT/nav.adoc b/documentation/IDTA-01005/modules/ROOT/nav.adoc
@@ -0,0 +1,26 @@
+////
+Copyright (c) 2023 Industrial Digital Twin Association
+
+This work is licensed under a [Creative Commons Attribution 4.0 International License](
+https://creativecommons.org/licenses/by/4.0/). 
+
+SPDX-License-Identifier: CC-BY-4.0
+
+Illustrations:
+Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
+////
+
+* xref:terms-definitions-and-abbreviations.adoc[Terms and Definitions]
+* xref:preamble.adoc[Preamble]
+* xref:introduction.adoc[Introduction]
+* xref:basic-concepts-and-leading-picture.adoc[Basic Concepts and Leading Picture]
+* xref:aasx.adoc[AASX Specification]
+* xref:summary-and-outlook.adoc[Summary and Outlook]
+* Annex
+** xref:./annex/background.adoc[Background]
+* xref:changelog.adoc[Change Log]
+* xref:bibliography.adoc[Bibliography]
+
+
+
+