Skip to content
This repository was archived by the owner on Jun 11, 2025. It is now read-only.

Commit a8a21be

Browse files
committed
Update README.md
Signed-off-by: Ihor Solodrai <isolodrai@meta.com>
1 parent 3ba17e8 commit a8a21be

File tree

1 file changed

+2
-71
lines changed

1 file changed

+2
-71
lines changed

README.md

Lines changed: 2 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,3 @@
1-
# Kernel Patches Daemon
1+
Kernel Patches Daemon source code has been moved to https://github.com/kernel-patches/kernel-patches-daemon
22

3-
Kernel Patches Daemon (`kpd`), watches patchwork for new series sent to the mailing
4-
list, applies the series on top of `repo`.
5-
6-
`repo` maintains base branches by pulling updates from `<upstream>@<upstream_branch>`
7-
and applying the CI files from `<ci_repo>@<ci_branch>` to it.
8-
9-
When `kpd` sees a new or updated series, it applies the patches from the series
10-
on top of one of the maintained branch and creates a PR against it.
11-
12-
This in turns triggers the Github workflows copied from `ci_repo`.
13-
14-
When the workflow runs are reporting back, `kpd` updates the relevant checks for
15-
this series on patchwork (when the configuration provides a `pw_token` and
16-
`pw_user`).
17-
18-
## Configuration
19-
`kpd.conf.template` is an example config based on the setup of https://github.com/kernel-patches/bpf
20-
21-
The branch `bpf-next` uses [Github personal token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
22-
to authenticate, while the branch `bpf`
23-
uses [Github App](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app).
24-
25-
When using a GH app, it needs to have the following read and write access:
26-
- Content (write to repo)
27-
- Pull request (create PRs)
28-
- Workflow
29-
30-
## Building
31-
```
32-
# Install poetry
33-
pip install --user poetry
34-
35-
# Setup virtualenv
36-
python -m venv .venv
37-
poetry install
38-
39-
# Test
40-
poetry run python -m unittest
41-
```
42-
43-
## Running
44-
```
45-
poetry run python -m kernel_patches_daemon --config <config_path> --label-color configs/labels.json
46-
```
47-
48-
## Docker
49-
50-
Kernel Patches Daemon is available as pre-build image:
51-
52-
```
53-
$ docker pull ghcr.io/facebookincubator/kernel-patches-daemon:latest
54-
```
55-
56-
To build Kernel Patches Daemon with [Docker](https://docs.docker.com/engine/install):
57-
58-
1. Install [Docker](https://docs.docker.com/engine/install) and [docker-compose](https://docs.docker.com/compose/install/)
59-
2. Build image
60-
```
61-
$ docker-compose build
62-
```
63-
3. Start KPD service
64-
```
65-
$ docker-compose up
66-
```
67-
68-
## CONTRIBUTING
69-
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
70-
71-
## License
72-
Kernel Patches Daemon is BSD licensed, as found in the LICENSE file.
3+
Please submit your issues and pull requests there.

0 commit comments

Comments
 (0)