Skip to content

Commit 465dbe6

Browse files
christophfroehlichmergify[bot]
authored andcommitted
Add CI job for docs (#424)
(cherry picked from commit 8462152) # Conflicts: # doc/migration.rst # doc/release_notes.rst
1 parent 35f6a24 commit 465dbe6

4 files changed

Lines changed: 76 additions & 0 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Jazzy Check Docs
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- jazzy
8+
paths:
9+
- '**.rst'
10+
- '**.md'
11+
- '**.jpg'
12+
- '**.jpeg'
13+
- '**.png'
14+
- '**.svg'
15+
- '**.yml'
16+
- '**.yaml'
17+
- '!.github/**' # exclude yaml files in .github directory
18+
- '.github/workflows/jazzy-check-docs.yml'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
jobs:
25+
check-docs:
26+
name: Check Docs
27+
uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@jazzy
28+
with:
29+
CONTROL_TOOLBOX_PR: ${{ github.ref }}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Rolling Check Docs
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- ros2-master
8+
paths:
9+
- '**.rst'
10+
- '**.md'
11+
- '**.jpg'
12+
- '**.jpeg'
13+
- '**.png'
14+
- '**.svg'
15+
- '**.yml'
16+
- '**.yaml'
17+
- '!.github/**' # exclude yaml files in .github directory
18+
- '.github/workflows/rolling-check-docs.yml'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
jobs:
25+
check-docs:
26+
name: Check Docs
27+
uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@rolling
28+
with:
29+
CONTROL_TOOLBOX_PR: ${{ github.ref }}

doc/migration.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/migration.rst
2+
3+
Migration Guides: Jazzy to Kilted
4+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5+
This list summarizes important changes between Jazzy (previous) and Kilted (current) releases, where changes to user code might be necessary.
6+
7+
Pid/PidRos
8+
***********************************************************
9+
* The parameters ``antiwindup``, ``i_clamp_max``, and ``i_clamp_min`` have been removed. The anti-windup behavior is now configured via the ``AntiWindupStrategy`` enum. (`#298 <https://github.com/ros-controls/control_toolbox/pull/298>`_).

doc/release_notes.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/release_notes.rst
2+
3+
Release Notes: Jazzy to Kilted
4+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5+
This list summarizes the changes between Jazzy (previous) and Kilted (current) releases.
6+
7+
Pid/PidRos
8+
***********************************************************
9+
* Added a saturation feature to PID output and two anti-windup techniques (back calculation and conditional integration) (`#298 <https://github.com/ros-controls/control_toolbox/pull/298>`_).

0 commit comments

Comments
 (0)