Skip to content

Document UBUNTU_CODENAME bootstrap override in users-guide.md #29

Description

@coderabbitai

Summary

docs/users-guide.md documents the new subagent manifest section, but does not document the new UBUNTU_CODENAME bootstrap override introduced for rust-entrypoint-system in PR #26.

Rationale

rust-entrypoint-system's configure_ubuntu_sources now accepts an optional codename override via the PHASE_UBUNTU_CODENAME environment variable (sourced from UBUNTU_CODENAME). When unset, it falls back to reading VERSION_CODENAME from /etc/os-release in a nounset-safe way, and fails fast if the codename still cannot be determined. None of this behaviour is currently documented for users.

Required changes

  • Add a UBUNTU_CODENAME entry to the system bootstrap documentation in docs/users-guide.md.
  • Explain the /etc/os-release (VERSION_CODENAME) fallback behaviour.
  • State explicitly when operators should use the override (e.g. hosts with missing or non-standard /etc/os-release codename fields).

Affected areas

  • docs/users-guide.md
  • rust-entrypoint-system

Acceptance criteria

  • docs/users-guide.md documents the UBUNTU_CODENAME override.
  • Documentation explains the /etc/os-release fallback and failure behaviour.
  • Documentation states when to use the override.

Links

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions