mirror of
https://github.com/certbot/certbot.git
synced 2026-07-28 08:05:31 +02:00
cb02885928
Related to https://github.com/certbot/certbot/issues/10581 Following up on https://github.com/certbot/certbot/pull/10631, https://github.com/certbot/certbot/pull/10622, and https://github.com/certbot/certbot/pull/10634, this PR converts the release [pipeline](https://dev.azure.com/certbot/certbot/_build?definitionId=3) from Azure to Github Actions. While this is the last migration PR, I don't think we should close the issue, as we're still using launchpad for armhf builds. I plan to continue investigating that and at minimum write up my findings. To test [notifications](https://opensource.eff.org/eff-open-source/pl/nfgh6obi8tfqikn4ydp7dshakr) and creating a [github release](https://github.com/ohemorange/Things-that-are-gr9/releases/tag/v1.0.19), I ran workflows that no-oped most the other jobs [in a test repo](https://github.com/ohemorange/Things-that-are-gr9/actions/runs/25938082721) (I've made minor changes to names and comments since then, but no code changes). Everything else is basically the same as nightly, with different tags. For the docker deployment, `${{ github.ref_name }}` is the tag name, so `v1.2.3`. Why not parametrize the tests a bit more, by putting an `env` at the top with `dockerTag: ${{ github.ref_name }}` and `snapReleaseChannel: beta`? Because the `env` context is [not available](https://docs.github.com/en/actions/reference/workflows-and-actions/contexts#context-availability) to `with`; only `github, needs, strategy, matrix, inputs, vars`. We could use `vars`, by creating `docker_tag_release` or whatever in the [variable section](https://github.com/certbot/certbot/settings/variables/actions) of the repo settings by using the web interface, but that seems worse to me than having it in the file but twice. You will note that the contents of `release.yml` are very similar to `nightly.yml`. While it would be nice to factor that out and reuse the code, github actions would then flatten everything in the grouped code together, making the results much harder to check. You can see what that flattening would look like [here](https://github.com/ohemorange/Things-that-are-gr9/actions/runs/25941524972) (if we put them all in one workflow). Currently, it will look something like [this](https://github.com/certbot/certbot/actions/runs/25688414262), which is much more readable. We could split it into "stages" like we had in azure pipelines (probably 1. standard and extended tests (and changelog?), 2. snap package and deploy (depend on tests), 3. docker package and deploy (depend on tests), 4. github release (depend on snap package and deploy), 5-6. notify (depend on github release)), but in addition to a minor slowdown (currently github release only depends on snap and docker package, not deploy, just so we're trying to do all the deployments simultaneously and not partially in case of build failures), it would still be only like three fewer jobs, since we'd still want all the info passing and dependency relationships. While it would be nice from a UX perspective to group the two notification jobs together, you can't do that cleanly using the built-in `if` key, and I don't think it's worth switching to a messier github api-based version just to group them. For mattermost notifications, we currently get the person to tag by running `AUTHOR_NAME="$(git log -1 --pretty=format:'%an')"` and mapping that to mattermost username. We could instead use `github.actor` to get the github handle, and map that instead. I didn't bother since we already have working, tested code, but can if a reviewer thinks it's worth it. --------- Co-authored-by: Will Greenberg <willg@eff.org> Co-authored-by: Brad Warren <bmw@users.noreply.github.com>
.. This file contains a series of comments that are used to include sections of this README in other files. Do not modify these comments unless you know what you are doing. tag:intro-begin |build-status| .. |build-status| image:: https://img.shields.io/azure-devops/build/certbot/ba534f81-a483-4b9b-9b4e-a60bec8fee72/5/main :target: https://dev.azure.com/certbot/certbot/_build?definitionId=5 :alt: Azure Pipelines CI status .. image:: https://raw.githubusercontent.com/EFForg/design/master/logos/certbot/eff-certbot-lockup.png :width: 200 :alt: EFF Certbot Logo Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identity of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server. Anyone who has gone through the trouble of setting up a secure website knows what a hassle getting and maintaining a certificate is. Certbot and Let’s Encrypt can automate away the pain and let you turn on and manage HTTPS with simple commands. Using Certbot and Let's Encrypt is free. .. _installation: Getting Started --------------- The best way to get started is to use our `interactive guide <https://certbot.eff.org>`_. It generates instructions based on your configuration settings. In most cases, you’ll need `root or administrator access <https://certbot.eff.org/faq/#does-certbot-require-root-administrator-privileges>`_ to your web server to run Certbot. Certbot is meant to be run directly on your web server on the command line, not on your personal computer. If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issued by Let’s Encrypt. Contributing ------------ If you'd like to contribute to this project please read `Developer Guide <https://certbot.eff.org/docs/contributing.html>`_. This project is governed by `EFF's Public Projects Code of Conduct <https://www.eff.org/pages/eppcode>`_. Links ===== .. Do not modify this comment unless you know what you're doing. tag:links-begin Documentation: https://certbot.eff.org/docs Software project: https://github.com/certbot/certbot Changelog: https://github.com/certbot/certbot/blob/main/certbot/CHANGELOG.md For Contributors: https://certbot.eff.org/docs/contributing.html For Users: https://certbot.eff.org/docs/using.html Main Website: https://certbot.eff.org Let's Encrypt Website: https://letsencrypt.org Community: https://community.letsencrypt.org ACME spec: `RFC 8555 <https://tools.ietf.org/html/rfc8555>`_ ACME working area in github (archived): https://github.com/ietf-wg-acme/acme .. Do not modify this comment unless you know what you're doing. tag:links-end .. Do not modify this comment unless you know what you're doing. tag:intro-end .. Do not modify this comment unless you know what you're doing. tag:features-begin Current Features ===================== * Supports multiple web servers: - Apache 2.4+ - nginx/0.8.48+ - webroot (adds files to webroot directories in order to prove control of domains and obtain certificates) - standalone (runs its own simple webserver to prove you control a domain) - other server software via `third party plugins <https://certbot.eff.org/docs/using.html#third-party-plugins>`_ * The private key is generated locally on your system. * Can talk to the Let's Encrypt CA or optionally to other ACME compliant services. * Can get domain-validated (DV) certificates. * Can revoke certificates. * Supports ECDSA (default) and RSA certificate private keys. * Can optionally install a http -> https redirect, so your site effectively runs https only. * Fully automated. * Configuration changes are logged and can be reverted. .. Do not modify this comment unless you know what you're doing. tag:features-end Thanks ------ We appreciate the donation of credits to help us test and develop Certbot from: .. image:: https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg :width: 201 :alt: DigitalOcean Logo :target: https://www.digitalocean.com/