Skip to content

Commit c9d28a7

Browse files
juileetikekarjuileetikekar
authored
Merge pull request #33 from admin-shell-io/IDTA-01005-3-1_working
V3.1
2 parents 4a07835 + ed7b5a6 commit c9d28a7

30 files changed

Lines changed: 1078 additions & 4 deletions

‎.github/workflows/check-changed-files.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Check-changed-files
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened]
6+
7+
permissions:
8+
actions: read
9+
10+
jobs:
11+
qodana:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Fetch Sources
15+
uses: actions/checkout@v4
16+
with:
17+
fetch-depth: ${{ github.event.pull_request.commits }}
18+
19+
- name: Get two more commits so Qodana we can identify the changes
20+
if: github.event_name == 'pull_request'
21+
run: git fetch --deepen=2
22+
23+
- name: Run Qodana inspection
24+
uses: JetBrains/qodana-action@v2024.3.4
25+
with:
26+
upload-result: true
27+
args: >
28+
--baseline,doc/qodana-baseline.sarif.json,
29+
--config,.qodana/qodana.yaml
30+
31+
# This step uploads the SARIF file to GitHub so that the code scanning feature can use it.
32+
# 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
33+
- name: Upload SARIF report to GitHub
34+
uses: github/codeql-action/upload-sarif@v3
35+
with:
36+
sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
################################################################################
2+
# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
3+
################################################################################
4+
5+
/.vs

‎.qodana/asciidoc-inspection.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<component name="InspectionProjectProfileManager">
2+
<profile version="1.0" is_locked="true">
3+
<!-- GrazieInspection normally has a TYPO preference -->
4+
<inspection_tool class="GrazieInspection" enabled="true" level="WARNING" enabled_by_default="true"/>
5+
<inspection_tool class="AsciiDocAnchorWithoutId" enabled="true" level="WARNING" enabled_by_default="true" />
6+
<inspection_tool class="AsciiDocAttributeContinuation" enabled="true" level="WARNING" enabled_by_default="true" />
7+
<inspection_tool class="AsciiDocBlockMacroShouldBeInlineMacro" enabled="true" level="WARNING" enabled_by_default="true" />
8+
<inspection_tool class="AsciiDocDescriptionExists" enabled="true" level="WARNING" enabled_by_default="true" />
9+
<inspection_tool class="AsciiDocDescriptionLength" enabled="true" level="WARNING" enabled_by_default="true" />
10+
<inspection_tool class="AsciiDocHeadingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
11+
<inspection_tool class="AsciiDocHorizontalRule" enabled="true" level="WARNING" enabled_by_default="true" />
12+
<inspection_tool class="AsciiDocInlineMacroShouldBeBlockOrPreprocessorMacro" enabled="true" level="WARNING" enabled_by_default="true" />
13+
<inspection_tool class="AsciiDocLinkResolve" enabled="true" level="ERROR" enabled_by_default="true" />
14+
<inspection_tool class="AsciiDocListingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
15+
<inspection_tool class="AsciiDocPageBreak" enabled="true" level="WARNING" enabled_by_default="true" />
16+
<inspection_tool class="AsciiDocReferencePattern" enabled="true" level="ERROR" enabled_by_default="true" />
17+
<inspection_tool class="AsciiDocXrefWithFileExtension" enabled="true" level="WARNING" enabled_by_default="true" />
18+
<inspection_tool class="AsciiDocXrefWithNaturalCrossReference" enabled="true" level="WARNING" enabled_by_default="true" />
19+
<inspection_tool class="AsciiDocAttributeShouldBeDefined" enabled="true" level="WARNING" enabled_by_default="true" />
20+
<inspection_tool class="AsciiDocObsoletePassthrough" enabled="true" level="WARNING" enabled_by_default="true" />
21+
<inspection_tool class="AsciiDocUnresolvedAntoraModule" enabled="true" level="ERROR" enabled_by_default="true" />
22+
<inspection_tool class="SpellCheckingInspection" enabled="true" level="WARNING" enabled_by_default="true">
23+
<option name="processCode" value="true" />
24+
<option name="processLiterals" value="true" />
25+
<option name="processComments" value="true" />
26+
</inspection_tool>
27+
<inspection_tool class="Style" enabled="true" level="WARNING" enabled_by_default="true" />
28+
</profile>
29+
</component>

‎.qodana/qodana.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: 1.0
2+
profile:
3+
path: .qodana/asciidoc-inspection.xml
4+
linter: jetbrains/qodana-jvm-community:2024.3
5+
plugins:
6+
- id: org.asciidoctor.intellij.asciidoc
7+
8+
include:
9+
- name: HttpUrlsUsage
10+
- name: GrazieInspection
11+
12+
exclude:
13+
- name: All
14+
paths:
15+
- .github
16+
- .qodana
17+
- CONTRIBUTING.md
18+
- LICENSE.txt
19+
- README.md
20+
- examples

‎README.md‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
12
# IDTA-01005 Package File Format (AASX)
23

4+
35
Repository of the Specification of the Asset Administration Shell - Part 5: Package File Format (AASX)
46

57
## Industrial Digital Twin Association (IDTA)
@@ -8,16 +10,36 @@ Governance of the specification is done in the working group **Open Technology**
810

911
The specification number is: **IDTA-01005**
1012

13+
14+
## Releases
15+
16+
The following versioning scheme is applied: 'V\<major>.\<minor>.\<patch>'.
17+
Major versions indicate breaking changes while minor updates are backward compatible.
18+
The patch position is increased whenever bugfixes need to be applied.
19+
The following release contains the latest version of the AAS schemas
20+
(see also the [releases](https://github.com/admin-shell-io/aas-specs-aasx/releases)
21+
section of this repository):
22+
23+
* [3.1.0](https://github.com/admin-shell-io/aas-specs-aasx/releases/tag/v3.1.0)
24+
is the latest release for the `V3.1.0` version of the AASX Package File Format,
25+
containing the normative sources for the published document
26+
"Specification of the Asset Administration Shell: Part 5 -Package File Format (AASX)".
27+
28+
*Use this release if you want to work with the latest specified AAS version.*
29+
30+
31+
1132
## Contributing
1233

1334
Feature requests, reports about inconsistencies, mistakes *etc.* are highly
14-
welcome! Please [submit a new issue](
15-
https://github.com/admin-shell-io/aas-specs/issues/new
16-
).
35+
welcome! Please [submit a new issue](https://github.com/admin-shell-io/aas-specs-aasx/issues/new).
36+
37+
If you want to contribute, see [CONTRIBUTING.md](https://github.com/admin-shell-io/aas-specs-metamodel/blob/master/CONTRIBUTING.md).
38+
The same contribution rules apply as for [aas-specs-metamodel](https://github.com/admin-shell-io/aas-specs-metamodel).
1739

18-
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)
1940

2041
## License
2142

2243
This work is licensed under a [Creative Commons Attribution 4.0 International License](
2344
https://creativecommons.org/licenses/by/4.0/).
45+

‎documentation/IDTA-01005/antora.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: IDTA-01005
2+
3+
title: 'Part 5: Package File Format (AASX)'
4+
version: 'v3.1'
5+
display_version: 'in progress'
6+
prerelease: true
7+
8+
start_page: ROOT:index.adoc
9+
nav:
10+
- modules/ROOT/nav.adoc

‎documentation/IDTA-01005/modules/ROOT/images/aas-info-exchange-types.jpg‎

41.9 KB
Loading

‎documentation/IDTA-01005/modules/ROOT/images/aasx-file-structure.png‎

14.1 KB
Loading

‎documentation/IDTA-01005/modules/ROOT/images/aasx-package-gen-and-use.jpeg‎

159 KB
Loading

‎documentation/IDTA-01005/modules/ROOT/images/aasx-rels.png‎

17.1 KB
Loading

0 commit comments

Comments
 (0)