Skip to content

Commit 3d68ced

Browse files
committed
ci: upgrade checkout action and add front matter validation
Upgrade actions/checkout from v3 to v4. Add a validation step that checks all feature Markdown files have proper YAML front matter, catching malformed contributions before deploy. Signed-off-by: Christian Brauner <brauner@kernel.org>
1 parent c17429e commit 3d68ced

18 files changed

Lines changed: 31 additions & 21 deletions

.github/workflows/gh-pages.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
concurrency:
1414
group: ${{ github.workflow }}-${{ github.ref }}
1515
steps:
16-
- uses: actions/checkout@v3
16+
- uses: actions/checkout@v4
1717
with:
1818
submodules: true
1919
fetch-depth: 0
@@ -27,6 +27,20 @@ jobs:
2727
- name: Build
2828
run: cd website && hugo --minify -d ../public
2929

30+
- name: Validate front matter
31+
run: |
32+
errors=0
33+
for f in $(find website/content -name '*.md' ! -name '_index.md'); do
34+
if ! head -1 "$f" | grep -q '^---$'; then
35+
echo "ERROR: $f missing front matter"
36+
errors=$((errors + 1))
37+
fi
38+
done
39+
if [ "$errors" -gt 0 ]; then
40+
echo "$errors file(s) with missing front matter"
41+
exit 1
42+
fi
43+
3044
- name: Deploy
3145
uses: peaceiris/actions-gh-pages@v3
3246
if: ${{ github.ref == 'refs/heads/main' }}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ cd kernel-features/website
3535
hugo server
3636
```
3737

38-
Requires [Hugo](https://gohugo.io/) (extended edition, v0.147.8+).
38+
Requires [Hugo](https://gohugo.io/) (extended edition).
3939

4040
## License
4141

website/content/completed/api-to-determine-the-parent-process-id-of-a-pidfd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ easily before even calling that syscall.
2121

2222
**🙇 `cdda1f26e74b ("pidfd: add ioctl to retrieve pid info")` 🙇**
2323

24-
**Usecase:** systemd manages a multitude of processes, most of which
24+
**Use-Case:** systemd manages a multitude of processes, most of which
2525
are its own children, but many which are not. It would be great if
2626
we could easily determine whether it is worth waiting for
2727
`SIGCHLD`/`waitid()` on them or whether waiting for `POLLIN` on

website/content/completed/make-statx-on-a-pidfd-return-additional-info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ These fields should in particular be queriable *after* the process
2121
already exited and has been reaped, i.e. after its PID has already
2222
been recycled.
2323

24-
**Usecase:** In systemd we maintain lists of processes in a hash
24+
**Use-Case:** In systemd we maintain lists of processes in a hash
2525
table. Right now, the key is the PID, but this is less than ideal
2626
because of PID recycling. By being able to use the `.stx_btime`
2727
and/or `.stx_ino` fields instead would be perfect to safely

website/content/completed/set-comm-field-before-exec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ https://github.com/systemd/systemd/commit/8939eeae528ef9b9ad2a21995279b76d382d5c
2929

3030
**🙇 `543841d18060 ("exec: fix up /proc/pid/comm in the execveat(AT_EMPTY_PATH) case")` 🙇**
3131

32-
**Usecase:** In systemd we generally would prefer using `fexecve()`
32+
**Use-Case:** In systemd we generally would prefer using `fexecve()`
3333
to safely and race-freely invoke processes, but the fact that `comm`
3434
is useless after invoking a process that way makes the call
3535
unfortunately hard to use for systemd.

website/content/completed/take-ip-unicast-if-into-account-for-routing-decisions.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: "Take `IP_UNICAST_IF` into account for routing decisions"
33
weight: 110
44
status: completed
55
categories:
6-
- security
76
- sockets
87
commit: "0e4d354762cefd3e16b4cff8988ff276e45effc4"
98
---

website/content/in-progress/ability-to-put-user-xattrs-on-s-ifsock-socket-entrypoint-inodes-in-the-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Currently, the kernel only allows extended attributes in the
1414
inodes. It would be tremendously useful to allow them to be
1515
associated with socket inodes, too.
1616

17-
**Usecase:** There are two syslog RFCs in use today: RFC3164 and
17+
**Use-Case:** There are two syslog RFCs in use today: RFC3164 and
1818
RFC5424. `glibc`'s `syslog()` API generates events close to the
1919
former, but there are programs which would like to generate the
2020
latter instead (as it supports structured logging). The two formats

website/content/in-progress/create-empty-mount-namespaces-via-unshare-unshare-empty-mntns-and-clone3-clone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Now that we have support for `nullfs` it is trivial to allow the
1313
creation of completely empty mount namespaces, i.e., mount namespaces
1414
that only have the `nullfs` mount located at it's root.
1515

16-
**Usecase:** This allows to isolate tasks in completely empty mount
16+
**Use-Case:** This allows to isolate tasks in completely empty mount
1717
namespaces. It also allows the caller to avoid copying its current mount
1818
table which is useless in the majority of container workload cases.

website/content/wishlist/add-process-by-pidfd-to-a-cgroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ hence can control that it hasn't been reaped yet, and hence
1717
guarantees the PID is valid. This is racy however if "foreign"
1818
processes shall be moved into the cgroup.
1919

20-
**Usecase:** In systemd, all user sessions are wrapped in scope
20+
**Use-Case:** In systemd, all user sessions are wrapped in scope
2121
units which are backed by a cgroup. The session processes moved into
2222
the scope unit are typically "foreign" processes, i.e. not children
2323
of the service manager, hence doing the movement is subject to races

website/content/wishlist/at-empty-path-support-for-openat-and-openat2.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "`AT_EMPTY_PATH` support for `openat()` and `openat2()`"
33
weight: 420
44
status: wishlist
55
categories:
6-
- general
6+
- processes
77
---
88

99
To get an operable version of an `O_PATH` file descriptors, it is
@@ -16,6 +16,3 @@ similar functions have `AT_EMPTY_PATH`.
1616

1717
**Use-Case:** When dealing with `O_PATH` file descriptors, allow
1818
re-opening an operable version without the need of `procfs`.
19-
20-
21-
## Finished Items

0 commit comments

Comments
 (0)