Skip to content

Commit e01bfe6

Browse files
authored
Update doc, add .gitignore and recommended vscode extension (#3)
* Add hadolint to recommended vscode extensions * Add Action publish-docker-image.yml
1 parent f3fa265 commit e01bfe6

File tree

5 files changed

+35
-7
lines changed

5 files changed

+35
-7
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@ jobs:
1111
runs-on: ubuntu-18.04
1212

1313
steps:
14-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
1514
- uses: actions/checkout@v2
1615

17-
# Runs a single command using the runners shell
1816
- name: Run builder script with arguments `--help`
1917
run: ./build-kernel.sh --help
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish Docker Image
2+
3+
# on:
4+
# push:
5+
# branches: [ master, develop ]
6+
# pull_request:
7+
# branches: [ master, develop ]
8+
9+
jobs:
10+
publish-docker-image:
11+
runs-on: ubuntu-18.04
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Publish Docker image
17+
uses: docker/build-push-action@v1
18+
with:
19+
username: ${{ secrets.DOCKER_USERNAME }}
20+
password: ${{ secrets.DOCKER_PASSWORD }}
21+
repository: tschaffter/${{ github.event.repository.name }}
22+
tag_with_ref: true
23+
push: ${{ startsWith(github.ref, 'refs/tags/') }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
output/

.vscode/extensions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"exiasr.hadolint"
4+
]
5+
}

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,11 @@ Check the above documentation to make sure that these examples are up-to-date.
5656
### Cross-compile the kernel
5757

5858
The command below builds the branch `rpi-4.19.y` for the Raspberry Pi 4
59-
(`bcm2711_defconfig`). Because this branch is not stable, we include today's
60-
date to the value of `--kernel-localversion` (`4.19.y-20200614-hardened`).
59+
(`bcm2711_defconfig`). Because this branch is in progress, we include today's
60+
date to the value of `--kernel-localversion` (`4.19.y-20200614-hardened`). You
61+
can set the value of `--kernel-localversion` to anything you want.
6162

62-
Once installed, the full kernel name will be
63+
Once installed, the full kernel name will be:
6364

6465
```console
6566
$ uname -a
@@ -105,7 +106,7 @@ Copy the Debian packages `$PWD/output/*.deb` to the target Raspbery Pi, for
105106
example using `scp`, then follow the instructions given at the end of the build
106107
command.
107108

108-
## Notes
109+
## Customize your build
109110

110111
- The builder uses all the CPU cores available to the Docker container. By default,
111112
that is all the CPU cores of the host. Use
@@ -120,7 +121,7 @@ a different toolchain and kernel source code.
120121

121122
```console
122123
$ git clone <toolchain-repo> tools
123-
$ git cllone <kernel-repo> linux
124+
$ git clone <kernel-repo> linux
124125
$ docker run \
125126
--rm \
126127
-v $PWD/output:/output \

0 commit comments

Comments
 (0)