Skip to content

Commit

Permalink
Add doc build snapshot nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
pionix-compiler committed Jul 12, 2024
1 parent 3a16990 commit 345c9e9
Show file tree
Hide file tree
Showing 10 changed files with 382 additions and 38 deletions.
105 changes: 100 additions & 5 deletions docs/latest/_sources/general/release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,94 @@ commits on GitHub:

EVerest releases are scheduled monthly. A release for a dedicated month can be
expected in the beginning of the following month. Each third release (March,
June, September and December) will be a stable releases including a two week
June, September and December) will be a stable release including a two week
feature freeze phase before the release date.

Here are the some high-level changes for the releases starting from release
2024.3.0:
Here are the some high-level changes for the last releases (starting from the
most recent one backwards):

2024.6.0 - LATEST STABLE
========================

Security Fix: Prevent integer overflow in EvseV2G
-------------------------------------------------

Reading the **v2gtp** message could potentially lead to an integer overflow.
This fix has been backported to the previous stable version of EVerest
(2024.3.1).

See the corresponding security advisory with CVE ID
`CVE-2024-37310 <https://github.com/EVerest/everest-core/security/advisories/GHSA-8g9q-7qr9-vc96>`_
.

New EXI implementation and license improvement
----------------------------------------------

The EvseV2G module is now using libcbv2g as EXI implementation instead of
OpenV2G's implementation. This means, that the EVerest project has been freed
from commercial-unfriendly licenses as the LGPLv3 is not part of EVerest
anymore with this change.

The libcbv2g has been released in the 0.2.0 version with improved cmake
integration, refactoring of unit tests and a simple CI in it.

Version information displayed
-----------------------------

EVerest manager displays version information at startup including also the
version of everest-core.

A flag can be set at startup that allows also displaying the version numbers
of other modules used in your EVerest build.

Further mentions of changes
---------------------------

Further improvements regarding Bazel builds have been done (reading of
dependencies.yaml on the fly).

Ubuntu 20.04 is not supported anymore.

CableCheck as been adapted to IEC-23 (2023).

2024.5.0
========

Cloud: Refactored database exception handling
---------------------------------------------

Implemented an alternative way to exception handling to prevent from crashes
in some cases, so that the system can continue working.

OCPP 1.6: ChargeX - MREC
------------------------

The Minimum Required Error Codes (MREC) have been refactored. Further
development will follow in next releases.

New BSP driver: Phytec phyVERSO
-------------------------------

Newly integrated driver in EVerest as open-source:
`Phytec phyVERSO as part of open-source EVerest <https://github.com/EVerest/everest-core/pull/648>`_
.

Bazel improvement regarding git tags
------------------------------------

When parsing the dependencies file, it is checked whether there are tags or
commit hashes.

For implementation details, see:
`Bazel: choose tags or commit <https://github.com/EVerest/everest-core/pull/654>`_

Minor EvseManager changes
-------------------------

More logging and some bug-fixing in EvseManager has been done.

In EvseV2G, DIN 70121 is enabled by default. Given reason: Strive for a max of
compatibility.

2024.4.0
========
Expand Down Expand Up @@ -102,8 +185,20 @@ counterpart of the EvseManager to be able to simulate charging sessions.

A C++ implementation will be coming soon.

2024.3.0 - LATEST STABLE
========================
2024.3.1
========

Security Fix: Prevent integer overflow in EvseV2G
-------------------------------------------------

Reading the **v2gtp** message could potentially lead to an integer overflow.

See the corresponding security advisory with CVE ID
`CVE-2024-37310 <https://github.com/EVerest/everest-core/security/advisories/GHSA-8g9q-7qr9-vc96>`_
.

2024.3.0
========

Plug & Charge
-------------
Expand Down
14 changes: 7 additions & 7 deletions docs/latest/appendix/02_snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2024.6.0</span>
<span class="nt">everest</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/EVerest.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">b0b27293755df8ec7a5852927663fc4266c79d34</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9f279b0c4f783a51176fa7d967f54e21835011d8</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-core</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/everest-core.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">41bed1f9dd76b0b35a824a2fec160bbbc014218c</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">b2ea2fea496f083cfb2ecda748cb203c36acc8b7</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-framework</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/everest-framework.git</span>
Expand All @@ -69,7 +69,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.3.1</span>
<span class="nt">everest.github.io</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:everest/everest.github.io.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8e4586a393e148350e4b69242216bedc081c0568</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3a1699049b94abf02543a4434d625253bc12038b</span>
<span class="nt">ext-mbedtls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cmake_condition</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EVEREST_DEPENDENCY_ENABLED_MBEDTLS</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/ext-mbedtls.git</span>
Expand All @@ -87,17 +87,17 @@ <h3>Navigation</h3>
<span class="nt">libevse-security</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cmake_condition</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EVEREST_DEPENDENCY_ENABLED_LIBEVSE_SECURITY</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/libevse-security.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1ee9a962c49d22ea4a46c84ab9d51ebf80345e6e</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.7.0</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">b140c17b0a5eaf09b60035605ed8aeb84627eb78</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">b140c17b0a5eaf09b60035605ed8aeb84627eb78</span>
<span class="nt">libfsm</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cmake_condition</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EVEREST_DEPENDENCY_ENABLED_LIBFSM</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/libfsm.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">b31d5f97cc3e09186e21eddf8cb3bcb133d7bc3c</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.2.0</span>
<span class="nt">liblog</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/liblog.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">19dce0ec3afda8d61bb95a6455a79913b732ec44</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.2.1</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3eab950e4bbf433b4df300ebeb419b749e8a2afa</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.2.2</span>
<span class="w"> </span><span class="nt">options</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">BUILD_EXAMPLES OFF</span>
<span class="nt">libmodbus</span><span class="p">:</span>
Expand Down
89 changes: 83 additions & 6 deletions docs/latest/general/release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,79 @@ <h3>Navigation</h3>
<a class="reference external" href="https://github.com/EVerest/everest-core/releases">EVerest releases</a></p>
<p>EVerest releases are scheduled monthly. A release for a dedicated month can be
expected in the beginning of the following month. Each third release (March,
June, September and December) will be a stable releases including a two week
June, September and December) will be a stable release including a two week
feature freeze phase before the release date.</p>
<p>Here are the some high-level changes for the releases starting from release
2024.3.0:</p>
<p>Here are the some high-level changes for the last releases (starting from the
most recent one backwards):</p>
<section id="latest-stable">
<h2>2024.6.0 - LATEST STABLE<a class="headerlink" href="#latest-stable" title="Permalink to this heading"></a></h2>
<section id="security-fix-prevent-integer-overflow-in-evsev2g">
<h3>Security Fix: Prevent integer overflow in EvseV2G<a class="headerlink" href="#security-fix-prevent-integer-overflow-in-evsev2g" title="Permalink to this heading"></a></h3>
<p>Reading the <strong>v2gtp</strong> message could potentially lead to an integer overflow.
This fix has been backported to the previous stable version of EVerest
(2024.3.1).</p>
<p>See the corresponding security advisory with CVE ID
<a class="reference external" href="https://github.com/EVerest/everest-core/security/advisories/GHSA-8g9q-7qr9-vc96">CVE-2024-37310</a>
.</p>
</section>
<section id="new-exi-implementation-and-license-improvement">
<h3>New EXI implementation and license improvement<a class="headerlink" href="#new-exi-implementation-and-license-improvement" title="Permalink to this heading"></a></h3>
<p>The EvseV2G module is now using libcbv2g as EXI implementation instead of
OpenV2G’s implementation. This means, that the EVerest project has been freed
from commercial-unfriendly licenses as the LGPLv3 is not part of EVerest
anymore with this change.</p>
<p>The libcbv2g has been released in the 0.2.0 version with improved cmake
integration, refactoring of unit tests and a simple CI in it.</p>
</section>
<section id="version-information-displayed">
<h3>Version information displayed<a class="headerlink" href="#version-information-displayed" title="Permalink to this heading"></a></h3>
<p>EVerest manager displays version information at startup including also the
version of everest-core.</p>
<p>A flag can be set at startup that allows also displaying the version numbers
of other modules used in your EVerest build.</p>
</section>
<section id="further-mentions-of-changes">
<h3>Further mentions of changes<a class="headerlink" href="#further-mentions-of-changes" title="Permalink to this heading"></a></h3>
<p>Further improvements regarding Bazel builds have been done (reading of
dependencies.yaml on the fly).</p>
<p>Ubuntu 20.04 is not supported anymore.</p>
<p>CableCheck as been adapted to IEC-23 (2023).</p>
</section>
</section>
<section id="id1">
<h2>2024.4.0<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<h2>2024.5.0<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<section id="cloud-refactored-database-exception-handling">
<h3>Cloud: Refactored database exception handling<a class="headerlink" href="#cloud-refactored-database-exception-handling" title="Permalink to this heading"></a></h3>
<p>Implemented an alternative way to exception handling to prevent from crashes
in some cases, so that the system can continue working.</p>
</section>
<section id="ocpp-1-6-chargex-mrec">
<h3>OCPP 1.6: ChargeX - MREC<a class="headerlink" href="#ocpp-1-6-chargex-mrec" title="Permalink to this heading"></a></h3>
<p>The Minimum Required Error Codes (MREC) have been refactored. Further
development will follow in next releases.</p>
</section>
<section id="new-bsp-driver-phytec-phyverso">
<h3>New BSP driver: Phytec phyVERSO<a class="headerlink" href="#new-bsp-driver-phytec-phyverso" title="Permalink to this heading"></a></h3>
<p>Newly integrated driver in EVerest as open-source:
<a class="reference external" href="https://github.com/EVerest/everest-core/pull/648">Phytec phyVERSO as part of open-source EVerest</a>
.</p>
</section>
<section id="bazel-improvement-regarding-git-tags">
<h3>Bazel improvement regarding git tags<a class="headerlink" href="#bazel-improvement-regarding-git-tags" title="Permalink to this heading"></a></h3>
<p>When parsing the dependencies file, it is checked whether there are tags or
commit hashes.</p>
<p>For implementation details, see:
<a class="reference external" href="https://github.com/EVerest/everest-core/pull/654">Bazel: choose tags or commit</a></p>
</section>
<section id="minor-evsemanager-changes">
<h3>Minor EvseManager changes<a class="headerlink" href="#minor-evsemanager-changes" title="Permalink to this heading"></a></h3>
<p>More logging and some bug-fixing in EvseManager has been done.</p>
<p>In EvseV2G, DIN 70121 is enabled by default. Given reason: Strive for a max of
compatibility.</p>
</section>
</section>
<section id="id2">
<h2>2024.4.0<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
<section id="added-charging-schedules-definition">
<h3>Added charging schedules definition<a class="headerlink" href="#added-charging-schedules-definition" title="Permalink to this heading"></a></h3>
<p>Introducing a new OCPP type in EVerest to process charging schedules.</p>
Expand Down Expand Up @@ -111,8 +178,18 @@ <h3>JsEvManager as replacement for JsCarSimulator<a class="headerlink" href="#js
<p>A C++ implementation will be coming soon.</p>
</section>
</section>
<section id="latest-stable">
<h2>2024.3.0 - LATEST STABLE<a class="headerlink" href="#latest-stable" title="Permalink to this heading"></a></h2>
<section id="id3">
<h2>2024.3.1<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h2>
<section id="id4">
<h3>Security Fix: Prevent integer overflow in EvseV2G<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<p>Reading the <strong>v2gtp</strong> message could potentially lead to an integer overflow.</p>
<p>See the corresponding security advisory with CVE ID
<a class="reference external" href="https://github.com/EVerest/everest-core/security/advisories/GHSA-8g9q-7qr9-vc96">CVE-2024-37310</a>
.</p>
</section>
</section>
<section id="id6">
<h2>2024.3.0<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h2>
<section id="plug-charge">
<h3>Plug &amp; Charge<a class="headerlink" href="#plug-charge" title="Permalink to this heading"></a></h3>
<p>The full process around a Plug&amp;Charge session has been implemented, which
Expand Down
Binary file modified docs/latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Large diffs are not rendered by default.

Loading

0 comments on commit 345c9e9

Please sign in to comment.