← Back to issue list

Update init templates to use a single current Charmcraft docs link

View original Github issue

Metadata

Project
charmcraft
Number
#2793
Type
pull request
State
closed
Author
Copilot
Labels
—
Created
Updated
Closed

Current evaluation

PR #2793 was closed unmerged after a maintainer said its single-link cleanup was the opposite of the requested change.

Resolution: closed stale

Reason: PR #2793 was abandoned after @lengau commented, “This is the opposite of what I asked for.” No resolving commit or superseding change was identified in the PR discussion.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The generated `charmcraft.yaml` files still carried multiple inline documentation links, including older or redundant references. This change consolidates template output around a single current Charmcraft documentation URL. - **Template cleanup** - Updates the machine and Kubernetes `init` templates to keep one canonical `charmcraft.yaml` reference at the top of the file. - Removes section-local documentation comments for platforms, config, containers, resources, and Juju configuration guidance. - **Generated output contract** - Tightens `init` integration coverage so generated `charmcraft.yaml` files: - include exactly one canonical Charmcraft docs link, - place it at the top of the file, - omit the removed legacy documentation comment patterns. - **Resulting template shape** ```yaml # This file configures Charmcraft. # See https://documentation.ubuntu.com/charmcraft/stable/reference/files/charmcraft-yaml-file/ for guidance. type: charm name: my-charm ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed stale PR #2793 was closed unmerged after a maintainer said its single-link cleanup was the opposite of the requested change.
stealth/space-bunny-alpha — closed stale Rejected and closed unmerged: PR #2793 consolidated init templates onto one top-level docs link, which maintainer @lengau said was the opposite of what was requested.
qwen/qwen3.6-35b-a3b — — Rejected and closed without merging. A maintainer noted the template cleanup contradicted previous requests, as it removed legacy documentation comments instead of consolidating them as intended.
qwen3.6-35b-a3b-mtp-q6 — — Closed without merging. The init template update consolidating Charmcraft documentation links was rejected after a maintainer noted it contradicted prior feedback. Changes were abandoned.

Update history

Date Change
created

Related issues

Issue Project State Summary Similarity
#2213 Change templates to link to current documentation charmcraft open Maintainer task to update charmcraft.yaml templates to link to modern documentation instead of outdated juju.is pages and remove repeated/outdated info; unlabelled and unassessed.
72%