Skip to content
tedge-dot
AI-driventedge-dot is developed largely by AI coding agents, and it is alpha software. Check what it does before you rely on it, and report what you find.

Release highlights

The changelog generated by release-please lists one line per feat/fix commit. When a change needs more than that for the person upgrading (what is new and how to use it, a changed default, a deprecation, a step to take), add a highlight: one Markdown file in this directory, in the same pull request.

  • Name it after the change, e.g. changes/opcua-namespace-table.md.
  • Start with a ### heading, then a short paragraph and bullets. Say what changed and what the reader has to do, and link to the full documentation in the repository rather than repeating it. Install instructions do not belong here; they live in doc/install.md.

The release workflow puts every highlight added since the previous published release on the GitHub release, in the order the files were added, above the changelog. A highlight appears on exactly one release; editing it later does not repeat it. The files stay here as the history.

A tag whose GitHub release has no assets (its release run failed) never reached users, so it does not count as published: the next release that is published carries that tag’s highlights and its changelog section as well.