Skip to content

Commit

Permalink
Review findings
Browse files Browse the repository at this point in the history
  • Loading branch information
erikbosch committed Sep 11, 2024
1 parent 1f19fd2 commit 07de8f2
Show file tree
Hide file tree
Showing 7 changed files with 340 additions and 322 deletions.
11 changes: 8 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
uses: actions/checkout@v4

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.6.0
uses: peaceiris/actions-hugo@v3.0.0
with:
hugo-version: "0.123.3"
extended: true
Expand All @@ -48,10 +48,15 @@ jobs:
- name: Check
continue-on-error: true
run: |
echo $(docker run -v $(pwd)/public:/public -v $(pwd)/.htmltest.yml:/.htmltest.yml --rm wjdp/htmltest -s /public -c /.htmltest.yml) >> $GITHUB_STEP_SUMMARY
echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY
docker run -v $(pwd)/public:/public -v $(pwd)/.htmltest.yml:/.htmltest.yml --rm wjdp/htmltest -s /public -c /.htmltest.yml >> $GITHUB_STEP_SUMMARY || true
echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY
- name: Publish to GH Pages
uses: peaceiris/[email protected]
# Note that gh_pages isnt published to https://eclipse-velocitas.github.io/velocitas-docs/
# or the alias https://eclipse.dev/velocitas/
# So this basically just check if there are errors :-)
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#
# SPDX-License-Identifier: Apache-2.0

name: CI workflow
name: Linters

on:
workflow_dispatch:
Expand All @@ -30,7 +30,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Run linters
uses: pre-commit/[email protected].0
uses: pre-commit/[email protected].1
11 changes: 7 additions & 4 deletions .github/workflows/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#
# SPDX-License-Identifier: Apache-2.0

name: Preview
name: Publish Documentation

on:
workflow_dispatch:
Expand All @@ -26,7 +26,7 @@ jobs:
uses: actions/checkout@v4

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.6.0
uses: peaceiris/actions-hugo@v3.0.0
with:
hugo-version: "0.123.3"
extended: true
Expand All @@ -45,10 +45,13 @@ jobs:
- name: Check for broken links
continue-on-error: true
run: |
echo $(docker run -v $(pwd)/public:/public -v $(pwd)/.htmltest.yml:/.htmltest.yml --rm wjdp/htmltest -s /public -c /.htmltest.yml) >> $GITHUB_STEP_SUMMARY
echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY
# Test below broken?
docker run -v $(pwd)/public:/public -v $(pwd)/.htmltest.yml:/.htmltest.yml --rm wjdp/htmltest -s /public -c /.htmltest.yml >> $GITHUB_STEP_SUMMARY || true
echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY
- name: Publish to docs branch
uses: peaceiris/actions-gh-pages@v3.9.0
uses: peaceiris/actions-gh-pages@v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/concepts/development_model/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Vehicle data is stored in the KUKSA Databroker conforming to an underlying [Sema
The Vehicle Signal Specification ([VSS](https://covesa.github.io/vehicle_signal_specification/)) provides a domain taxonomy for vehicle signals and defines the vehicle data semantically, which is exchanged between _Vehicle Apps_ and the Databroker.

The Velocitas SDK is using [VSS](https://covesa.github.io/vehicle_signal_specification/) as the semantic model for the Vehicle Model.
Vehicle Service models can be defined with [Protobuf service definitions](vehicle_app_manifest/interfaces/grpc_interface/).

### Communication Protocols

Expand Down
Loading

0 comments on commit 07de8f2

Please sign in to comment.