Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 2 additions & 71 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,72 +1,3 @@
# Kernel Patches Daemon
Kernel Patches Daemon source code has been moved to https://github.com/kernel-patches/kernel-patches-daemon

Kernel Patches Daemon (`kpd`), watches patchwork for new series sent to the mailing
list, applies the series on top of `repo`.

`repo` maintains base branches by pulling updates from `<upstream>@<upstream_branch>`
and applying the CI files from `<ci_repo>@<ci_branch>` to it.

When `kpd` sees a new or updated series, it applies the patches from the series
on top of one of the maintained branch and creates a PR against it.

This in turns triggers the Github workflows copied from `ci_repo`.

When the workflow runs are reporting back, `kpd` updates the relevant checks for
this series on patchwork (when the configuration provides a `pw_token` and
`pw_user`).

## Configuration
`kpd.conf.template` is an example config based on the setup of https://github.com/kernel-patches/bpf

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)
to authenticate, while the branch `bpf`
uses [Github App](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app).

When using a GH app, it needs to have the following read and write access:
- Content (write to repo)
- Pull request (create PRs)
- Workflow

## Building
```
# Install poetry
pip install --user poetry

# Setup virtualenv
python -m venv .venv
poetry install

# Test
poetry run python -m unittest
```

## Running
```
poetry run python -m kernel_patches_daemon --config <config_path> --label-color configs/labels.json
```

## Docker

Kernel Patches Daemon is available as pre-build image:

```
$ docker pull ghcr.io/facebookincubator/kernel-patches-daemon:latest
```

To build Kernel Patches Daemon with [Docker](https://docs.docker.com/engine/install):

1. Install [Docker](https://docs.docker.com/engine/install) and [docker-compose](https://docs.docker.com/compose/install/)
2. Build image
```
$ docker-compose build
```
3. Start KPD service
```
$ docker-compose up
```

## CONTRIBUTING
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.

## License
Kernel Patches Daemon is BSD licensed, as found in the LICENSE file.
Please submit your issues and pull requests there.