mirror of
https://github.com/certbot/certbot.git
synced 2026-08-01 16:19:13 +02:00
Brad WarrenandGitHub
208ff18405
as those with access can see [here](https://github.com/certbot/certbot/security/dependabot), dependabot recently got confused by our readthedocs.org.requirements.txt files my read of the situation looking at output like [this](https://github.com/certbot/certbot/actions/runs/25448194392/job/74658002711#step:3:72) is dependabot expects paths to local packages to be relative to the requirements file while readthedocs wants them to relative to the root of the repo. (i tested changing the paths to be relative to the requirements file and [readthedocs was not happy](https://app.readthedocs.org/projects/eff-certbot/builds/32592654/)) to deal with this, we could create a .github/dependabot.yaml file and set [exclude-paths](https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#exclude-paths-), but it strikes me as even simpler and cleaner to just remove these files if possible our use of these readthedocs.org.requirements.txt files dates back to https://github.com/certbot/certbot/pull/261, long before readthedocs added its .readthedocs.yaml files which we much more recently adopted in https://github.com/certbot/certbot/pull/9762. inspired by the suggestions at https://github.com/readthedocs/readthedocs.org/issues/7258 to workaround the lack of support for constraints files, i took the approach of [customizing the build process](https://docs.readthedocs.com/platform/stable/build-customization.html) we luckily don't have to override any of the existing readthedocs build steps. for reference, the build process is described [here](https://docs.readthedocs.com/platform/stable/builds.html), however, if you compare the readthedocs build logs from [main](https://app.readthedocs.org/projects/eff-certbot/builds/32568259/) and [this branch](https://app.readthedocs.org/projects/eff-certbot/builds/32597332/), you'll see they are essentially identical in addition to the certbot build, i also triggered [acme](https://app.readthedocs.org/projects/acme-python/builds/32597344/) and [dns-cloudflare](https://app.readthedocs.org/projects/certbot-dns-cloudflare/builds/32597347/) builds from this branch which passed as well i personally think we can get away with just one review on this PR, but if the reviewer disagrees, by all means request a second one
32 lines
1.1 KiB
YAML
32 lines
1.1 KiB
YAML
# Read the Docs configuration file for Sphinx projects
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the OS, Python version and other tools you might need
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.11"
|
|
# You can also specify other tool versions
|
|
jobs:
|
|
post_install:
|
|
# Using a constraints file isn't natively supported. We use a
|
|
# post_install job with the following flags and method of invoking pip to
|
|
# most closely mimic the current default installation behavior.
|
|
- python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-google[docs]
|
|
|
|
# Build documentation in the "docs/" directory with Sphinx
|
|
sphinx:
|
|
configuration: certbot-dns-google/docs/conf.py
|
|
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
|
|
# builder: "dirhtml"
|
|
# Fail on all warnings to avoid broken references
|
|
fail_on_warning: true
|
|
|
|
# Optionally build your docs in additional formats such as PDF and ePub
|
|
formats:
|
|
- pdf
|
|
- epub
|