Skip to content

Commit 222d21e

Browse files
committed
Configure release drafter
1 parent b33d6f4 commit 222d21e

3 files changed

Lines changed: 94 additions & 16 deletions

File tree

.github/release-drafter.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name-template: 'v$RESOLVED_VERSION'
3+
tag-template: 'v$RESOLVED_VERSION'
4+
template: |
5+
# Changelog
6+
7+
$CHANGES
8+
9+
See details of [all code changes](https://github.com/ferrarimarco/docker-pxe/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since the previous release
10+
11+
categories:
12+
- title: '🚀 Features'
13+
labels:
14+
- 'feature'
15+
- 'enhancement'
16+
- title: '🐛 Bug Fixes'
17+
labels:
18+
- 'fix'
19+
- 'bugfix'
20+
- 'bug'
21+
- title: '🧰 Maintenance'
22+
labels:
23+
- 'infrastructure'
24+
- 'automation'
25+
- 'documentation'
26+
- title: '🏎 Performance'
27+
label: 'performance'
28+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
29+
version-resolver:
30+
major:
31+
labels:
32+
- 'type: breaking'
33+
minor:
34+
labels:
35+
- 'type: enhancement'
36+
patch:
37+
labels:
38+
- 'type: bug'
39+
- 'type: maintenance'
40+
- 'type: documentation'
41+
default: patch
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Release Drafter
3+
4+
on:
5+
push:
6+
branches:
7+
- master
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
update_release_draft:
14+
permissions:
15+
contents: write # for release-drafter/release-drafter to create a github release
16+
pull-requests: write # for release-drafter/release-drafter to add label to PR
17+
runs-on: ubuntu-latest
18+
timeout-minutes: 60
19+
steps:
20+
- uses: release-drafter/release-drafter@v5
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ using Docker, you can add the `--net=host` option when running the container:
2727
docker run -it --rm --net=host ferrarimarco/pxe
2828
```
2929

30+
The container image is also available on GitHub container registry: [`ghcr.io/ferrarimarco/pxe`](https://github.com/ferrarimarco/docker-pxe/pkgs/container/pxe).
31+
32+
This container image is multi-platform, and supports the following platforms:
33+
34+
- `linux/amd64`
35+
- `linux/arm64`
36+
3037
### Integrated DHCP server
3138

3239
If you want to enable the integrated DHCP server for a given IP address range add a `dhcp-range` option: `dhcp-range=x.x.x.x,y.y.y.y,z.z.z.z` where `x.x.x.x` is the start of the range, `y.y.y.y` is the end and `z.z.z.z` is the subnet mask.
@@ -69,22 +76,30 @@ LABEL ubuntu-16-04-amd64
6976

7077
### How to run the test environment
7178

72-
1. Check the IP address ranged configured by the Virtualbox DHCP server and configure your `dhcp-range` and `/var/lib/tftpboot/pxelinux.cfg/default` accordingly.
73-
1. Run the container with a suitable DHCP configuration and the `--net=host` option
74-
1. Run `vagrant up` from the root of the directory where you cloned this repository. A Virtualbox VM (with a NATed network adapter) will boot from the given PXE.
79+
1. Check the IP address ranged configured by the Virtualbox DHCP server and
80+
configure your `dhcp-range` and `/var/lib/tftpboot/pxelinux.cfg/default` accordingly.
81+
1. Run the container with a suitable DHCP configuration and the `--net=host` option.
82+
1. Run `vagrant up` from the root of the directory where you cloned this
83+
repository. A Virtualbox VM (with a NATed network adapter) will boot from
84+
the given PXE.
7585

7686
#### Example
7787

78-
Virtualbox runs a DHCP server by default in each virtual network. If you want to test the PXE feature you have to run a
79-
container based on this image with dnsmasq as a DHCP proxy (see [Standalone Mode](#standalone-dhcp-server)) and with the
80-
host network stack (see the `--net=host` option) so you know in advance the IP address of the container running dnsmasq:
81-
it's the same as the Docker host!
82-
83-
For example, if Virtualbox DHCP server assigns addresses in the `192.168.56.0/24` subnet (check the virtual network
84-
configuration of the Host-only network assigned to a VM to gather this information),
85-
then the `dhcp-range` option to enable a DHCP proxy could be: `dhcp-range=192.168.56.2,proxy`,
86-
where `192.168.56.2` is the address assigned to the Docker host running the container based on this image in "host network" mode.
87-
88-
Remember to also update any IP address in `/var/lib/tftpboot/pxelinux.cfg/default` you may have configured, if you serve any
89-
content from the TFTP server (like a `preseed.cfg` for example) to point to the IP address of the container running this PXE.
90-
**For this reason it could be useful to manually assign (or reserve) IP addresses (or better, hostnames!) for containers running this PXE.**
88+
Virtualbox runs a DHCP server by default in each virtual network. If you want to
89+
test the PXE feature you have to run a container based on this image with
90+
dnsmasq as a DHCP proxy (see [Standalone Mode](#standalone-dhcp-server)) and
91+
with the host network stack (see the `--net=host` option) so you know in advance
92+
the IP address of the container running dnsmasq: it's the same as the Docker host!
93+
94+
For example, if Virtualbox DHCP server assigns addresses in the
95+
`192.168.56.0/24` subnet (check the virtual network configuration of the
96+
host-only network assigned to a VM to gather this information), then the
97+
`dhcp-range` option to enable a DHCP proxy could be: `dhcp-range=192.168.56.2,proxy`,
98+
where `192.168.56.2` is the address assigned to the Docker host running the
99+
container based on this image in "host network" mode.
100+
101+
Remember to also update any IP address in `/var/lib/tftpboot/pxelinux.cfg/default`
102+
you may have configured, if you serve any content from the TFTP server (like a
103+
`preseed.cfg` for example) to point to the IP address of the container running
104+
this PXE. For this reason, it could be useful to manually assign (or reserve)
105+
IP addresses (or better, hostnames!) for containers running this PXE.

0 commit comments

Comments
 (0)