Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
3d3bdbe
This adds a documentation skeleton to everest-core in its docs/ direc…
krealyt Nov 3, 2025
07550ad
(docs) add community channels (#1448)
andistorm Nov 4, 2025
d21c68c
doc(pnc): Add Explaination of Plug&Charge in EVerest (#1429)
Pietfried Nov 4, 2025
3cb70cd
Refactor _find_sphinx_build macro to allow system installation of sph…
andistorm Nov 4, 2025
2516de5
doc(tutorial): Add bazel documentation (#1456)
Pietfried Nov 4, 2025
767575d
Add Plug&Charge tutorial documentation (#1439)
Pietfried Nov 5, 2025
fe7ccd4
Add Configure Plug&Charge in EVerest documentation (#1428)
Pietfried Nov 5, 2025
b9670dd
doc(explanation): Add devtool documentation (#1445)
Pietfried Nov 5, 2025
fc666e7
Add OCPP1.6 documentation (#1434)
Pietfried Nov 10, 2025
8191112
doc(tutorial): Added OCPP2.x tutorial to docs (#1435)
Pietfried Nov 12, 2025
6c13117
Add ISO15118 debugging documentation (#1495)
Pietfried Nov 17, 2025
9710ea5
doc(explanation): Add hardware architecture documentation (#1449)
andistorm Nov 17, 2025
c1a79be
Add develop new modules to documentation (#1458)
Pietfried Nov 18, 2025
1832176
Add documentation for Linux/Yocto/Cross compilation (#1459)
Pietfried Nov 18, 2025
7f3202a
docs(explanation): Adds how-to guides for Eichrecht and UK Smart Char…
Pietfried Nov 25, 2025
e0184cd
doc(explanation): Add High-Level EVerest overview to docs (#1453)
Pietfried Nov 25, 2025
952cab4
Add renesas mpu docs (#1457)
Pietfried Nov 25, 2025
6ae44b5
doc(how-to): Add security best practices to documentation (#1573)
Pietfried Nov 27, 2025
a0dbf73
docs(api): Move EVerest API asyncapi spec and build and provide HTMLs…
cburandt Nov 27, 2025
efd56dd
docs: fix various bugs (broken links, broken formating, missing conte…
cburandt Nov 27, 2025
0898936
Add basic BringUp documentation (#1576)
Pietfried Nov 27, 2025
ddfac2b
Add Adapt EVerest documentation (#1577)
Pietfried Nov 27, 2025
3cc7c0e
Add Getting Started documentation (#1574)
Pietfried Nov 27, 2025
35347e2
Formatting fixes in getting started docs
Pietfried Nov 27, 2025
01255a0
Fix references in asnycapi docs
Pietfried Nov 27, 2025
664238b
Move from doc.rst -> docs/index.rst in BUOcppConsumer and IMDSimulator
Pietfried Nov 27, 2025
a7b7abf
Fix broken links
cburandt Dec 1, 2025
a85dd68
Add TSC section in community channels
Pietfried Dec 3, 2025
4626064
Updated tsc resources
Pietfried Dec 3, 2025
90774d0
Updated repo to dev-hardware-yocto
Pietfried Dec 8, 2025
8a296c3
Update headline
Pietfried Dec 8, 2025
f987120
Update images
Pietfried Dec 8, 2025
dac0ded
Fix TODOs and add EVerest APIs to Getting Started section
Pietfried Dec 9, 2025
1c95b7d
Minor fixes (links + avoid warnings, remove references to BC, mark
cburandt Dec 11, 2025
17c7d74
Add OTA RAUC partitioning + drivers (from BC appendix)
cburandt Dec 11, 2025
cf5acec
added index.rst for all BU modules
Pietfried Dec 12, 2025
a935a15
Removed adapt everest from toctree and link in getting started direct…
Pietfried Dec 12, 2025
89f763f
Add qa to toc
Pietfried Dec 12, 2025
0144a04
Remove checkboxes
Pietfried Dec 12, 2025
f7481c2
Fix markdown link
Pietfried Dec 12, 2025
2db8212
Suppress sphinx warnings
cburandt Dec 12, 2025
f7d35f8
Fix visual appearance and some formatting violations
cburandt Dec 12, 2025
76b7c92
Move Huawei driver docs to docs/index.rst
Pietfried Dec 22, 2025
d45bb56
Remove add_subdirectory(doc)
Pietfried Dec 22, 2025
20c5ae3
Move EnergyManager module docs to seperate chapter in explanation/
Pietfried Dec 22, 2025
a40de5c
Rework index page and add some guidance for starters
cburandt Dec 19, 2025
621190b
Allow to build docs without async-api-depending API docs
cburandt Dec 19, 2025
64bea40
Move 'community' to the sidebar
cburandt Dec 19, 2025
52994d4
Fix broken links/references
cburandt Dec 21, 2025
cf58500
Add 'Documenting EVerest' material
cburandt Dec 21, 2025
8ed99e6
Add Q&A content
cburandt Dec 22, 2025
81f0011
Add error framework content
cburandt Dec 22, 2025
4543e3e
Moved session_cost_consumer_API specs
Pietfried Jan 5, 2026
dab7aaa
Revert "Moved session_cost_consumer_API specs"
Pietfried Jan 5, 2026
a24c6a6
Move OCMF docs to explanations
Pietfried Jan 5, 2026
fc4ce8a
Add detailed module concept documentation (#1575)
Pietfried Jan 6, 2026
c2e5975
Fixed a couple of TODOs and references
Pietfried Jan 6, 2026
d386575
Move session_cost_consumer_API.yaml API definition
cburandt Jan 6, 2026
c5e8e9f
Move getting started pages to how-tos and provide quick-access from t…
cburandt Jan 6, 2026
e6fe4f7
Fix links and warnings
cburandt Jan 6, 2026
5d50985
Add explanation of 3-tier-mapping and fix related links
cburandt Jan 6, 2026
c8b4a4c
Fix duplications and bad formatting in auto-generated reference docum…
cburandt Jan 3, 2026
16a3f8e
Docs/add errors to reference section (#1686)
cburandt Jan 13, 2026
858c228
Address a couple of inline TODOs
Pietfried Jan 13, 2026
84058e9
Add build and deploy CI for new documentation (#1615)
andistorm Jan 13, 2026
5274596
Generate conf.py from CMake and fix API documentation links:
Pietfried Jan 13, 2026
bb4f1d9
Add paragraph for request/reply timeouts
Pietfried Jan 14, 2026
f1ab0f0
Fix references in OCPP(201) module documentation
cburandt Jan 14, 2026
7d2d0c2
Move AsyncAPI definition for slac_API to new location
cburandt Jan 14, 2026
0437b60
Fix semantic and cosmetic errors in AsyncAPI definitions
cburandt Jan 14, 2026
ab075e8
Fix duplicated reference and remove broken links to yaml files
cburandt Jan 14, 2026
42f2c15
configure with EVEREST_ENABLE_RS_SUPPORT=ON
andistorm Jan 14, 2026
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
35 changes: 35 additions & 0 deletions .ci/build-kit/scripts/build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/bin/sh

TRAILBOOK_everest_IS_RELEASE=${TRAILBOOK_everest_IS_RELEASE:-"OFF"}
TRAILBOOK_everest_INSTANCE_NAME=${TRAILBOOK_everest_INSTANCE_NAME:-"nightly"}
TRAILBOOK_everest_OVERWRITE_EXISTING_INSTANCE=${TRAILBOOK_everest_OVERWRITE_EXISTING_INSTANCE:-"OFF"}

mkdir -p ~/.ssh
ssh-keyscan github.com >> ~/.ssh/known_hosts
chmod 600 ~/.ssh/known_hosts

cmake \
-B "$EXT_MOUNT/build" \
-S "$EXT_MOUNT/source" \
-G Ninja \
-D EVC_ENABLE_CCACHE=ON \
-D EVEREST_ENABLE_COMPILE_WARNINGS=ON \
-D EVEREST_ENABLE_RS_SUPPORT=ON \
-D EVEREST_BUILD_DOCS=ON \
-D TRAILBOOK_everest_DOWNLOAD_ALL_VERSIONS=ON \
-D TRAILBOOK_everest_IS_RELEASE="$TRAILBOOK_everest_IS_RELEASE" \
-D TRAILBOOK_everest_INSTANCE_NAME="$TRAILBOOK_everest_INSTANCE_NAME" \
-D TRAILBOOK_everest_OVERWRITE_EXISTING_INSTANCE="$TRAILBOOK_everest_OVERWRITE_EXISTING_INSTANCE" \
-D EVEREST_DOCS_REPO_URL="$EVEREST_DOCS_REPO_URL"
retVal=$?
if [ $retVal -ne 0 ]; then
echo "Configuring failed with return code $retVal"
exit $retVal
fi

ninja -C "$EXT_MOUNT/build" trailbook_everest
retVal=$?
if [ $retVal -ne 0 ]; then
echo "Compiling failed with return code $retVal"
exit $retVal
fi
31 changes: 31 additions & 0 deletions .ci/build-kit/scripts/deploy_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/bin/sh

DEPLOYED_DOCS_REPO="$EXT_MOUNT/build/docs/deployed_docs_repo"

mkdir -p ~/.ssh
ssh-keyscan github.com >> ~/.ssh/known_hosts
chmod 600 ~/.ssh/known_hosts

git -C "$DEPLOYED_DOCS_REPO" config user.email "[email protected]"
git -C "$DEPLOYED_DOCS_REPO" config user.name "Pionix Github Service Account"

git -C "$DEPLOYED_DOCS_REPO" add .
retVal=$?
if [ $retVal -ne 0 ]; then
echo "Staging changes failed with return code $retVal"
exit $retVal
fi

git -C "$DEPLOYED_DOCS_REPO" commit -m "Update nightly documentation from commit $GITHUB_SHA"
retVal=$?
if [ $retVal -ne 0 ]; then
echo "Committing changes failed with return code $retVal"
exit $retVal
fi

git -C "$DEPLOYED_DOCS_REPO" push
retVal=$?
if [ $retVal -ne 0 ]; then
echo "Pushing changes failed with return code $retVal"
exit $retVal
fi
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
name: Bazel Build
name: Bazel Build And Test
run-name: ${{ github.actor }} is building with bazel
on:
pull_request: {}
merge_group: {}
workflow_call:
inputs:
runner:
description: 'Which runner to use'
required: false
default: 'ubuntu-24.04'
type: string
jobs:
bazel-build-and-test:
runs-on: ubuntu-22.04
runs-on: ${{ inputs.runner }}
steps:
- run: echo branch name is ${{ github.ref }}
- name: Checkout
Expand Down
85 changes: 85 additions & 0 deletions .github/workflows/job_build-build-kit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Build the build-kit

on:
workflow_call:
inputs:
runner:
description: 'Which runner to use'
required: false
default: 'ubuntu-24.04'
type: string
build_kit_docker_directory:
description: 'Directory in the repository where the build kit Dockerfile is located'
required: false
default: '.ci/build-kit/docker'
type: string
base_image_tag_everest_ci:
description: 'The tag of the everest-ci base image to use for building the build-kit'
required: true
type: string
outputs:
build_kit_artifact_name:
description: 'The name of the build-kit artifact'
value: ${{ jobs.build-build-kit.outputs.build_kit_artifact_name }}
build_kit_image_tag:
description: 'The tag of the built build-kit image'
value: ${{ jobs.build-build-kit.outputs.build_kit_image_tag }}

jobs:
build-build-kit:
name: Build the build-kit
runs-on: ${{ inputs.runner }}
env:
BUILD_KIT_ARTIFACT_NAME: build-kit
BUILD_KIT_IMAGE_NAME: local/build-kit-${{ github.event.repository.name }}
BUILD_ARGS: |
BASE_IMAGE_TAG=${{ inputs.base_image_tag_everest_ci }}
outputs:
build_kit_image_tag: ${{ steps.set-outputs.outputs.tag }}
build_kit_artifact_name: ${{ env.BUILD_KIT_ARTIFACT_NAME }}
steps:
- name: Checkout Dockerfile
uses: actions/checkout@v4
with:
repository: ${{ github.repository }}
path: source
ref: ${{ github.ref }}
token: ${{ github.token}}
fetch-depth: 0
- name: Docker Meta
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.BUILD_KIT_IMAGE_NAME }}
sep-tags: ","
- name: Setup Docker buildx
uses: docker/setup-buildx-action@v3
- name: Build
uses: docker/build-push-action@v6
with:
context: source/${{ inputs.build_kit_docker_directory }}
push: false
cache-from: type=gha
cache-to: type=gha,mode=max
build-args: ${{ env.BUILD_ARGS }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
outputs: type=docker,dest=build-kit.tar
- name: Upload build-kit image
uses: actions/upload-artifact@v4
with:
name: ${{ env.BUILD_KIT_ARTIFACT_NAME }}
path: build-kit.tar
- name: Set output tag
id: set-outputs
shell: python3 {0}
run: |
import os
tags = "${{ steps.meta.outputs.tags }}".split(",")
if len(tags) == 0:
print("No tags found!❌")
exit(1)
tag = tags[0]
with open(os.environ["GITHUB_OUTPUT"], "a") as f:
f.write(f"tag={tag}\n")
print(f"Set tag={tag}")
Loading
Loading