Skip to content

Commit 8cd78d9

Browse files
committed
CI: add "full" distribution to the release note
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
1 parent d770aae commit 8cd78d9

File tree

2 files changed

+66
-5
lines changed

2 files changed

+66
-5
lines changed

.github/workflows/release.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,11 @@ jobs:
3333
run: |
3434
tag="${GITHUB_REF##*/}"
3535
shasha=$(sha256sum _output/SHA256SUMS | awk '{print $1}')
36-
cat << EOF | tee /tmp/release-note.txt
36+
cat <<-EOF | tee /tmp/release-note.txt
3737
${tag}
3838
39-
#### Changes
40-
(To be documented)
41-
42-
#### About the binaries
39+
$(hack/generate-release-note.sh)
40+
- - -
4341
The binaries were built automatically on GitHub Actions.
4442
The build log is available for 90 days: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
4543

hack/generate-release-note.sh

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#!/bin/bash
2+
minimal_amd64tgz="$(find _output -name '*amd64.tar.gz*' -and ! -name '*full*')"
3+
full_amd64tgz="$(find _output -name '*amd64.tar.gz*' -and -name '*full*')"
4+
5+
minimal_amd64tgz_basename="$(basename ${minimal_amd64tgz})"
6+
full_amd64tgz_basename="$(basename ${full_amd64tgz})"
7+
8+
cat <<-EOX
9+
## Changes
10+
(To be documented)
11+
12+
## About the binaries
13+
- Minimal (\`${minimal_amd64tgz_basename}\`): nerdctl only
14+
- Full (\`${full_amd64tgz_basename}\`): Includes dependencies such as containerd, runc, and CNI
15+
16+
### Minimal
17+
Extract the archive to a path like \`/usr/local/bin\` or \`~/bin\` .
18+
<details><summary>tar Cxzvvf /usr/local/bin ${minimal_amd64tgz_basename}</summary>
19+
<p>
20+
21+
\`\`\`
22+
$(tar tzvf ${minimal_amd64tgz})
23+
\`\`\`
24+
</p>
25+
</details>
26+
27+
### Full
28+
Extract the archive to a path like \`/usr/local\` or \`~/.local\` .
29+
30+
<details><summary>tar Cxzvvf /usr/local ${full_amd64tgz_basename}</summary>
31+
<p>
32+
33+
\`\`\`
34+
$(tar tzvf ${full_amd64tgz})
35+
\`\`\`
36+
</p>
37+
</details>
38+
39+
<details><summary>Included components</summary>
40+
<p>
41+
42+
See \`share/doc/nerdctl-full/README.md\`:
43+
\`\`\`markdown
44+
$(tar xOzf ${full_amd64tgz} share/doc/nerdctl-full/README.md)
45+
\`\`\`
46+
</p>
47+
</details>
48+
49+
## Quick start
50+
### Rootful
51+
\`\`\`console
52+
$ sudo systemctl enable --now containerd
53+
$ sudo nerdctl run -d --name nginx -p 80:80 nginx:alpine
54+
\`\`\`
55+
56+
### Rootless
57+
\`\`\`console
58+
$ containerd-rootless-setuptool.sh install
59+
$ nerdctl run -d --name nginx -p 8080:80 nginx:alpine
60+
\`\`\`
61+
62+
Rootless mode requires systemd and cgroup v2, see https://rootlesscontaine.rs/getting-started/common/cgroup2/ .
63+
EOX

0 commit comments

Comments
 (0)