1
0
mirror of https://github.com/certbot/certbot.git synced 2026-01-26 07:41:33 +03:00
Files
certbot/docs/packaging.rst
Brad Warren 47f64c7280 Remove list of packaging efforts. (#7258)
I think this list maybe had value when distros were first starting to package Certbot, but now I don't think it does. What function does this list serve? The instruction generator at https://certbot.eff.org/instructions does a much better job telling users how to use these packages. On the packaging side, I think anyone capable of packaging Certbot at the various distros would be able to search their repositories to see if a Certbot package is available.

Since this list is hard to maintain as links semi-regularly break and keeping it up to date with all distros and all Certbot components is a fair bit of work, let's just remove it.

This PR was motivated by the Travis failures at https://travis-ci.com/certbot/website/builds/119588518 due to GNU Guix changing the layout of their site.
2019-07-19 10:44:17 -07:00

2.2 KiB

Packaging Guide

Releases

We release packages and upload them to PyPI (wheels and source tarballs).

The following scripts are used in the process:

We use git tags to identify releases, using Semantic Versioning. For example: v0.11.1.

Notes for package maintainers

  1. Please use our tagged releases, not master!
  2. Do not package certbot-compatibility-test or letshelp-certbot - it's only used internally.
  3. To run tests on our packages, you should use python setup.py test. Doing things like running pytest directly on our package files may not work because Certbot relies on setuptools to register and find its plugins.
  4. If you'd like to include automated renewal in your package certbot renew -q should be added to crontab or systemd timer. Additionally you should include a random per-machine time offset to avoid having a large number of your clients hit Let's Encrypt's servers simultaneously.
  5. jws is an internal script for acme module and it doesn't have to be packaged - it's mostly for debugging: you can use it as echo foo | jws sign | jws verify.
  6. Do get in touch with us. We are happy to make any changes that will make packaging easier. If you need to apply some patches don't do it downstream - make a PR here.