Skip to content

fix(docs): no .env step when a combo has no .env #55

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
ahze merged 1 commit into from
Oct 17, 2026
Merged

fix(docs): no .env step when a combo has no .env #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions dbuild/templates/README.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,13 +440,19 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
{{ cb.doc }}
{%- endif %}

{%- if cb.example_env | trim %}

**1.** Save as `.env`{% if cb.ask %} and fill in {{ cb.ask | map(attribute='label') | join(', ') }}{% else %} and fill in what is empty{% endif %}:

```env { data-zip-bundle="{{ cb.zip }}" data-zip-filename=".env" }
{{ cb.example_env | trim }}
```

**2.** Save as `compose.yaml`:
{%- else %}

Save as `compose.yaml`:
{%- endif %}

```yaml { data-zip-bundle="{{ cb.zip }}" data-zip-filename="compose.yaml" }
{{ cb.compose_text | trim }}
Expand Down
5 changes: 5 additions & 0 deletions dbuild/templates/README.mkdocs.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,18 @@
{% if cb.doc %}
{{ cb.doc }}
{% endif %}
{#- No .env at all (SQLite: nothing to set): no step asking to fill one in. #}
{% if cb.example_env_site | trim -%}
**1.** Save as `.env`{% if cb.ask %} and fill in {{ cb.ask | map(attribute='label') | join(', ') }}{% else %} and fill in what is empty{% endif %}:

```env { data-zip-bundle="{{ cb.zip }}" data-zip-filename=".env" }
{{ cb.example_env_site | trim }}
```

**2.** Save as `compose.yaml`:
{%- else -%}
Save as `compose.yaml`:
{%- endif %}

```yaml { data-zip-bundle="{{ cb.zip }}" data-zip-filename="compose.yaml" }
{{ cb.compose_text_site | trim }}
Expand Down
15 changes: 15 additions & 0 deletions tests/test_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1081,3 +1081,18 @@ def test_a_plain_quote_is_left_alone(self):
def test_important_and_caution_keep_their_word(self):
self.assertTrue(docs._site_alerts("> [!IMPORTANT]\n> x\n").startswith('!!! info "Important"\n'))
self.assertTrue(docs._site_alerts("> [!CAUTION]\n> x\n").startswith('!!! danger "Caution"\n'))


class TestNoEnvStep(unittest.TestCase):
def test_a_combination_without_env_has_no_env_step(self):
with tempfile.TemporaryDirectory() as d:
tmp = Path(d)
(tmp / "compose.yaml").write_text(_toggles_compose(2))
(tmp / "Containerfile.j2").write_text(CONTAINERFILE_J2)
with _chdir(tmp):
cfg = dbuild_config.load(tmp)
outputs, errors = docs.render_generated(cfg, argparse.Namespace(community=None), tmp)
self.assertEqual(errors, [])
podman = outputs["README.md"].split("### Podman Compose", 1)[1].split("### AppJail", 1)[0]
self.assertNotIn("Save as `.env`", podman, "no .env to fill in")
self.assertIn("Save as `compose.yaml`:", podman)
Loading