mirror of
https://github.com/certbot/certbot.git
synced 2026-06-06 07:12:54 -04:00
fc864543a7
This PR adds the following documentation improvements to fix https://github.com/certbot/certbot/issues/7958: - Simplify building external plugins - Separate out certbot snap instructions from plugin instructions - Mention that dnsimple is just an example for the plugin instructions - Mention remote build for other architectures - Mention snap doc exists elsewhere in developer guide (`contributing.rst`) * Set up generate_dnsplugins_all.sh for all files and parametrize snapcraft and postrefreshhook files * Create constraints file in the generate_dnsplugins_all script * Separate out plugin and certbot snaps and update instructions * Add remote build instructions * Add pointers to the README to contributing.rst
54 lines
1.5 KiB
Bash
Executable file
54 lines
1.5 KiB
Bash
Executable file
#!/bin/bash
|
|
# Generate the snapcraft.yaml file for a DNS plugins
|
|
# Usage: bash generate_dnsplugins_snapcraft.sh path/to/dns/plugin
|
|
# For example, from the certbot home directory:
|
|
# tools/snap/generate_dnsplugins_snapcraft.sh certbot-dns-dnsimple
|
|
set -e
|
|
|
|
PLUGIN_PATH=$1
|
|
PLUGIN=$(basename "${PLUGIN_PATH}")
|
|
DESCRIPTION=$(grep description "${PLUGIN_PATH}/setup.py" | sed -E 's|\s+description="(.*)",|\1|g')
|
|
mkdir -p "${PLUGIN_PATH}/snap"
|
|
cat <<EOF > "${PLUGIN_PATH}/snap/snapcraft.yaml"
|
|
# This file is generated by tools/generate_dnsplugins_snapcraft.sh and should not be edited manually.
|
|
name: ${PLUGIN}
|
|
summary: ${DESCRIPTION}
|
|
description: ${DESCRIPTION}
|
|
confinement: strict
|
|
grade: stable
|
|
base: core20
|
|
adopt-info: ${PLUGIN}
|
|
|
|
parts:
|
|
${PLUGIN}:
|
|
plugin: python
|
|
source: .
|
|
constraints: [\$SNAPCRAFT_PART_SRC/snap-constraints.txt]
|
|
override-pull: |
|
|
snapcraftctl pull
|
|
snapcraftctl set-version \`grep ^version \$SNAPCRAFT_PART_SRC/setup.py | cut -f2 -d= | tr -d "'[:space:]"\`
|
|
build-environment:
|
|
- SNAP_BUILD: "True"
|
|
# To build cryptography and cffi if needed
|
|
build-packages: [gcc, libffi-dev, libssl-dev, python3-dev]
|
|
certbot-metadata:
|
|
plugin: dump
|
|
source: .
|
|
stage: [setup.py, certbot-shared]
|
|
override-pull: |
|
|
snapcraftctl pull
|
|
mkdir -p \$SNAPCRAFT_PART_SRC/certbot-shared
|
|
|
|
slots:
|
|
certbot:
|
|
interface: content
|
|
content: certbot-1
|
|
read:
|
|
- \$SNAP/lib/python3.8/site-packages
|
|
|
|
plugs:
|
|
certbot-metadata:
|
|
interface: content
|
|
content: metadata-1
|
|
target: \$SNAP/certbot-shared
|
|
EOF
|