Repository navigation
fix: recommend a release in the README and correct input path messages - #79
Merged
Paymaun (digimaun) merged 6 commits intoOct 21, 2026
Merged
Paymaun (digimaun) merged 6 commits into
Paymaun (digimaun) merged 6 commits into
Conversation
…notes - The README quickstart names a recommended release and points to its ready-to-copy commands. The install commands keep the <release> placeholder, now quoted so an unedited paste fails as a download rather than a shell redirection. The release checklist updates the recommendation after publication. - The release renderer joins soft-wrapped paragraph and list lines in the authored notes, because GitHub shows each newline in a release body as a line break. Fences, HTML, tables, quotes, headings, hard breaks and indented code stay as written. - The ADO and GitHub input checks say that the manifest path is relative to the workspace, not the checkout. - The 2609 release configuration cites the CLI versions page and the product tag, like 2608.
…g when unwrapping notes - A list item joins only when its content is plain text and it is indented fewer than four spaces, so fences, headings and thematic breaks shaped like list items stay as written. - A closing fence must sit within three spaces of its opening fence. - pre, script, style and textarea blocks, comments, processing instructions, declarations and CDATA stay protected until their own terminator, across blank lines. - A line that ends in whitespace is never joined, because the space can be significant inside a code span.
…g notes Two lines now join only when both are plain prose outside anything that could be a code fence or raw HTML, and uncertain regions stay protected until a certain end: - A fence run anywhere in a line, including after a list marker, starts protection, which ends only at a closing fence in the same column. - Raw HTML that a blank line does not end, such as pre blocks and comments, is protected from wherever it appears in a line. - A list item joins only with one to four spaces after its marker, so indented code inside an item stays as written. - Text containing carriage returns is returned unchanged.
Remove the release-notes unwrapping. Three adversarial reviews kept finding Markdown where joining lines changed meaning, including code blocks, tables and link definitions, and a wrong join would silently change commands that readers copy. The renderer is unchanged from main, and the release guide asks authors to write each paragraph and list item on one line, because GitHub shows each newline in a release body as a line break.
There was a problem hiding this comment.
🟢 Approval recommended
The focused documentation, diagnostic, and regression-test changes have no identified blocking issues.
No open issues 🎉
What changed in this PR
Improves the Site Ops installation guidance and corrects workspace-relative manifest path messages.
Changes:
- Recommends a quickstart release and quotes Bash placeholders.
- Updates release guidance and regression tests.
- Clarifies pipeline diagnostics and refreshes 2609 source comments without changing configuration values.
| File | Description |
|---|---|
workspaces/iot-operations/parameters/aio-releases/2609.yaml |
Updates source comments only. |
tests/test_release_workflow.py |
Checks the quoted release placeholder. |
tests/test_installation_guide.py |
Tests recommendation links and unedited Bash commands. |
tests/test_ado_consumers.py |
Checks corrected path diagnostics. |
README.md |
Recommends a release and quotes Bash placeholders. |
docs/releasing.md |
Documents recommendation updates and release-note formatting. |
docs/install-siteops.md |
Quotes Bash release placeholders. |
.pipelines/templates/siteops-inputs.yaml |
Clarifies ADO path messages and comments. |
.github/workflows/_siteops-deploy.yaml |
Clarifies GitHub Actions path messages and comments. |
Review effort: Balanced
Name the recommended release in a full sentence, say how to use the commands below, and move other-release guidance into its own paragraph.
Sri Harsha Kalavala (shkalavala)
approved these changes
Oct 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<release>placeholder, now quoted in bash, so an unedited paste fails as a download instead of a shell redirection.Validation