Skip to content

Commit da86ac6

Browse files
authored
Fix the CI and add the symbol type to the docs ToC (#298)
- **Don't recursively scan for pyproject.toml when calculating the cache key** - **ci: Fix the condition to run the nox-all and nox-cross-arch-all jobs** - **mkdocs: Show symbol type in the ToC** - **Update release notes**
2 parents 8dea6d2 + 01b4bfd commit da86ac6

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

.github/workflows/ci.yaml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,14 @@ jobs:
8888
# The job name should match the name of the `nox` job.
8989
name: Test with nox
9090
needs: ["nox"]
91+
# We skip this job only if nox was also skipped
92+
if: always() && needs.nox.result != 'skipped'
9193
runs-on: ubuntu-20.04
94+
env:
95+
DEPS_RESULT: ${{ needs.nox.result }}
9296
steps:
93-
- name: Return true
94-
run: "true"
97+
- name: Check matrix job result
98+
run: test "$DEPS_RESULT" = "success"
9599

96100
nox-cross-arch:
97101
name: Cross-arch tests with nox
@@ -161,7 +165,7 @@ jobs:
161165
uses: actions/cache@v4
162166
with:
163167
path: /tmp/pip-cache
164-
key: nox-${{ matrix.nox-session }}-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('**/pyproject.toml') }}
168+
key: nox-${{ matrix.nox-session }}-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }}
165169

166170
# This ensures that the docker container has access to the pip cache.
167171
# Changing the user in the docker-run step causes it to fail due to
@@ -202,10 +206,14 @@ jobs:
202206
# The job name should match the name of the `nox-cross-arch` job.
203207
name: Cross-arch tests with nox
204208
needs: ["nox-cross-arch"]
209+
# We skip this job only if nox-cross-arch was also skipped
210+
if: always() && needs.nox-cross-arch.result != 'skipped'
205211
runs-on: ubuntu-20.04
212+
env:
213+
DEPS_RESULT: ${{ needs.nox-cross-arch.result }}
206214
steps:
207-
- name: Return true
208-
run: "true"
215+
- name: Check matrix job result
216+
run: test "$DEPS_RESULT" = "success"
209217

210218
build:
211219
name: Build distribution packages

RELEASE_NOTES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Frequenz channels Release Notes
22

3+
## Enhancements
4+
5+
- The API documentation now shows the type of symbol in the table of contents.
6+
37
## Bug Fixes
48

59
- Fix logger for the `Broadcast` channel (the log messages were missing the level, timestamp, etc.).

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ plugins:
120120
show_signature_annotations: true
121121
show_source: true
122122
show_symbol_type_toc: true
123+
show_symbol_type_toc: true
123124
signature_crossrefs: true
124125
import:
125126
# See https://mkdocstrings.github.io/python/usage/#import for details

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ dev-mkdocs = [
5757
"mkdocs-macros-plugin == 1.0.5",
5858
"mkdocs-material == 9.5.20",
5959
"mkdocstrings[python] == 0.25.0",
60+
"mkdocstrings-python == 1.9.2",
6061
"pymdownx-superfence-filter-lines == 0.1.0",
6162
]
6263
dev-mypy = [

0 commit comments

Comments
 (0)