Skip to content
This repository has been archived by the owner on Jan 20, 2025. It is now read-only.

Chore/add legal header to docs folder #74

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .tractusx
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ repositories:
- name: "SSI-agent-lib"
usage: "Implementation of Self-Sovereign Identity solution"
url: "https://github.com/eclipse-tractusx/SSI-agent-lib"
skipReleaseChecks:
# Skip TRG 4.02 aligned base images, as it won't be published
alignedBaseImage:
- "docs/pandoc.Dockerfile"
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [UNRELEASED]

### Added

- A `NOTICE.md` file to be processed inside of the `docs/` folder, containing the necessary legal
headers.
- A `skipReleaseChecks` section to the tractus-x metadata file, as the Dockerfile in the `docs/`
directory is not being published.

### Fixed

- The Docker image tag inside of the `docs/` directory use the `tractus-x` prefix now.

## [0.0.18-SNAPSHOT] 2023-12-4

### Added

- Extra layer of validation in `org.eclipse.tractusx.ssi.lib.proof.LinkedDataProofValidation` for `verify`.
- Extra layer of validation in `org.eclipse.tractusx.ssi.lib.proof.LinkedDataProofValidation`
for `verify`.

### Fixed

Expand Down
Binary file modified docs/Documentation.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/NOTICE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2023 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/SSI-agent-lib
4 changes: 2 additions & 2 deletions docs/pandoc.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ RUN echo '\\newpage' > /data/newpage.md
# Replace links to sub pages with anchors
RUN /bin/bash -c "sed -i -E 's/\((.*).md\)/\(#\L\1\)/g' /data/Architecture.md"
# Generate doc as pdf
RUN pandoc -s -o Documentation.pdf /data/README.md /data/newpage.md /data/Architecture.md /data/Feature-*.md /data/Test.md
RUN pandoc -s -o Documentation.pdf /data/README.md /data/newpage.md /data/Architecture.md /data/Feature-*.md /data/Test.md /data/NOTICE.md

ENTRYPOINT ["tail", "-f", "/dev/null"]
ENTRYPOINT ["tail", "-f", "/dev/null"]
4 changes: 2 additions & 2 deletions docs/scripts/generateDoc.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@
BASEDIR="$(dirname "$(dirname "$(readlink -fm "$0")")")"

echo $BASEDIR
docker build --no-cache --file "$BASEDIR"/pandoc.Dockerfile -t catena-x/pandoc-generator:latest "$BASEDIR"
containerId=$(docker create catena-x/pandoc-generator:latest)
docker build --no-cache --file "$BASEDIR"/pandoc.Dockerfile -t tractus-x/pandoc-generator:latest "$BASEDIR"
containerId=$(docker create tractus-x/pandoc-generator:latest)
docker cp "$containerId":/data/Documentation.pdf "$BASEDIR"