Skip to content

docs: clarify main branch is active development and link to latest build artifacts#417

Open
nmetulev wants to merge 3 commits intomainfrom
nm/readme-dev-builds
Open

docs: clarify main branch is active development and link to latest build artifacts#417
nmetulev wants to merge 3 commits intomainfrom
nm/readme-dev-builds

Conversation

@nmetulev
Copy link
Copy Markdown
Member

@nmetulev nmetulev commented Apr 8, 2026

Summary

Makes it clear to visitors that the \main\ branch contains active development work that may differ from released versions, and provides direct download links to the latest CI build artifacts.

Changes

  • NOTE callout at the top of README — explains that \main\ is active development, links to the latest stable release and the new build artifacts section
  • Build (main) status badge — shows CI status, links to the Actions workflow
  • \Install from latest build (main branch)\ section under Installation with:
    • Direct download links via nightly.link (no GitHub login required) for CLI binaries, npm package, MSIX, and NuGet artifacts
    • CAUTION callout warning about unreleased/experimental nature
    • Collapsed fallback instructions for downloading from GitHub Actions directly if nightly.link is unavailable

…ild artifacts

- Add NOTE callout explaining main branch may differ from released versions
- Add Build (main) status badge linking to CI workflow
- Add 'Install from latest build' section with direct nightly.link download
  links for CLI binaries, npm, MSIX, and NuGet artifacts
- Include CAUTION callout warning about unreleased/experimental nature
- Add collapsed fallback instructions for manual artifact download from
  GitHub Actions in case nightly.link is unavailable

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 8, 2026 23:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository README to better set expectations that main reflects active development (and may diverge from releases), and to provide convenient paths to obtain the latest CI-built artifacts.

Changes:

  • Add a NOTE callout clarifying main vs latest release and linking to the new “latest build” section.
  • Add a GitHub Actions build status badge for main.
  • Add an “Install from latest build (main branch)” section with nightly.link artifact downloads plus a fallback download flow via GitHub Actions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

Build Metrics Report

Binary Sizes

Artifact Baseline Current Delta
CLI (ARM64) 29.22 MB 29.22 MB ✅ 0.0 KB (0.00%)
CLI (x64) 29.67 MB 29.67 MB ✅ 0.0 KB (0.00%)
MSIX (ARM64) 12.32 MB 12.32 MB 📉 -0.1 KB (-0.00%)
MSIX (x64) 13.10 MB 13.10 MB 📈 +0.3 KB (+0.00%)
NPM Package 25.63 MB 25.63 MB 📈 +0.4 KB (+0.00%)
NuGet Package 25.71 MB 25.71 MB 📈 +0.2 KB (+0.00%)

Test Results

714 passed out of 714 tests in 345.6s (-69.1s vs. baseline)

Test Coverage

21% line coverage, 37.1% branch coverage · ✅ no change vs. baseline

CLI Startup Time

39ms median (x64, winapp --version) · ✅ no change vs. baseline


Updated 2026-04-09 05:39:17 UTC · commit d9edeb5 · workflow run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants