Skip to content
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.

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

Already on GitHub? Sign in to your account

add debconf-templates cookbook #1907

Merged
merged 2 commits into from Nov 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 56 additions & 0 deletions www/docs/cookbooks/debconf-templates.md
@@ -0,0 +1,56 @@
# Use debconf and templates

Deb installation format has a support for user input during installation using [debconf](https://manpages.debian.org/testing/debconf-doc/debconf-devel.7.en.html).

To enable it inside `goreleaser` you need:

`templates` file, what to ask (all templates go into single file):

```none
Template: foo/like_debian
Type: boolean
Description: Do you like Debian?
We'd like to know if you like the Debian GNU/Linux system.

Template: foo/why_debian_is_great
Type: note
Description: Poor misguided one. Why are you installing this package?
Debian is great. As you continue using Debian, we hope you will
discover the error in your ways.
```

Maintainer script file that will trigger questions, usually its `postinst` because all package files are already installed:

```sh
#!/bin/sh -e

# Source debconf library.
. /usr/share/debconf/confmodule

# Do you like debian?
db_input high foo/like_debian || true
db_go || true

# Check their answer.
# with db_get you load value into $RET env variable.
db_get foo/like_debian
if [ "$RET" = "false" ]; then
# Poor misguided one...
db_input high foo/why_debian_is_great || true
db_go || true
fi
```

Include `templates` and `postinst` in `.goreleaser.yml`:

```yaml
overrides:
deb:
scripts:
postinstall: ./deb/postinst
deb:
scripts:
templates: ./deb/templates
```

Useful tutorial: [Debconf Programmer's Tutorial](http://www.fifi.org/doc/debconf-doc/tutorial.html)
3 changes: 2 additions & 1 deletion www/docs/customization/nfpm.md
Expand Up @@ -207,8 +207,9 @@ nfpms:

# Custom configuration applied only to the Deb packager.
deb:
# Custom deb rules script.
# Custom deb special files.
scripts:
# Deb rules script.
rules: foo.sh
# Deb templates file, when using debconf.
templates: templates
Expand Down
1 change: 1 addition & 0 deletions www/mkdocs.yml
Expand Up @@ -89,6 +89,7 @@ nav:
- cookbooks/release-a-library.md
- cookbooks/publish-to-nexus.md
- cookbooks/cgo-and-crosscompiling.md
- cookbooks/debconf-templates.md
- tutorials.md
- links.md

Expand Down