Skip to content

Add version badges to README - #1938

Merged
CharliePoole merged 2 commits into
mainfrom
updt-readme
Oct 30, 2026
Merged

CharliePoole merged 2 commits into
mainfrom
updt-readme

Conversation

@CharliePoole

@CharliePoole CharliePoole commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Display latest versions of each package on nuget (stable or semi-stable) and myget (dev releases).

@CharliePoole

Copy link
Copy Markdown
Member Author

@oznetmaster I suggest you simply look at README.md in preview mode, since this is intended entirely for us and has too much detail for the final release. As a reminder, we consider the betas like beta.5 to be semi-stable and publish them to both nuget and myget, while the alphas and betas like beta.6.2 are dev releases and only go to myget. In both cases, we show the latest version, including pre-releases.

@oznetmaster

Copy link
Copy Markdown
Collaborator

@CharliePoole, I checked the README preview; the central version table is helpful. One small wording suggestion: replace “latest stable (nuget)” with “latest NuGet release, including prereleases,” to match the badges and your semi-stable beta policy.

Prepared by Neil Colvin with assistance from OpenAI Codex.

@oznetmaster

Copy link
Copy Markdown
Collaborator

@CharliePoole, the new workflow entries use path-exclude; GitHub’s exclusion key is paths-ignore, under both triggers.

Also, if Continuous Integration is now a required check, skipping the entire pull-request workflow for documentation changes can leave that check pending and block merging. We should retain a lightweight successful check while skipping the expensive build steps for documentation-only changes.

Prepared by Neil Colvin with assistance from OpenAI Codex.

@oznetmaster

Copy link
Copy Markdown
Collaborator

@CharliePoole, having seen the screenshot, that setting makes the “Update branch” option available when a PR falls behind; it doesn’t require updating before merging or make CI mandatory. My earlier warning about pending checks applies only if CI is separately configured as required. The paths-ignore syntax correction still applies.

Prepared by Neil Colvin with assistance from OpenAI Codex.

@CharliePoole

Copy link
Copy Markdown
Member Author

Hi Neil,

I'll make the change in the text as you suggest.

Thanks for pointing out my error in the yml file. I took it from an example but didn't copy/paste - just copied what I thought I was reading. Copilot edit completion even helped me do it but of course the yml is valid even if it isn't using the right properties for github workflows. I'll fix that of course.

I haven't made CI checks or reviews required. I prefer to use those settings that remind us to do the right thing rather than making anything impossible. This is among team members, of course. If anyone else contributes, they are unable to merge.

Charlie

@oznetmaster oznetmaster left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the README version table and workflow changes. The text now distinguishes NuGet prereleases from the additional MyGet development releases, and both workflow triggers use the correct paths-ignore key. With CI checks intentionally advisory, the earlier required-check concern does not apply to the current repository policy.

Continuous Integration and CLA both passed for the reviewed commit 41eb76b.

Prepared by Neil Colvin with assistance from OpenAI Codex.

@CharliePoole
CharliePoole merged commit 437a8ec into main Oct 30, 2026
2 checks passed
@CharliePoole
CharliePoole deleted the updt-readme branch October 30, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants