Skip to content

crate publishing workflow#755

Open
Copilot wants to merge 25 commits intomainfrom
copilot/automate-crate-publishing
Open

crate publishing workflow#755
Copilot wants to merge 25 commits intomainfrom
copilot/automate-crate-publishing

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 10, 2026

The automated publish workflow could only be triggered by pushing version tags, making it impossible to test changes to the workflow or validate a release without actually publishing to crates.io.

Changes

Workflow trigger

  • Added workflow_dispatch with dry_run input (defaults to true)
  • Skip tag version validation when manually triggered

Publish logic

  • Pass --dry-run flag to cargo publish when enabled
  • Skip crate availability polling in dry-run mode (no actual uploads)
  • Visual indicators for mode: 🧪 DRY-RUN MODE vs 📦 LIVE MODE

Documentation

  • RELEASING.md: Testing section with dry-run vs live comparison
  • .github/TESTING_RELEASES.md: Step-by-step testing guide

Usage

Manual test without publishing:

# GitHub Actions UI → "Publish to crates.io" → "Run workflow"
# Branch: main, dry_run: true

Actual publish (unchanged):

git tag v0.46.0 && git push origin v0.46.0

Dry-run validates packaging, dependencies, and publish order across all 15 crates without uploading to the registry.

Original prompt

This section details on the original issue you should resolve

<issue_title>Automate crate publishing</issue_title>
<issue_description>## Is your feature request related to a problem? Please describe.
Automatically publish new versions to crates.io</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 4 commits February 10, 2026 16:32
Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>
Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>
Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>
Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>
Copilot AI changed the title [WIP] Automate publishing of new versions to crates.io Automate crate publishing to crates.io Feb 10, 2026
Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>
Copilot AI changed the title Automate crate publishing to crates.io Add dry-run testing for crate publishing workflow Feb 10, 2026
@harsha-simhadri harsha-simhadri changed the title Add dry-run testing for crate publishing workflow crate publishing workflow Feb 17, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.49%. Comparing base (45428af) to head (0be6156).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #755   +/-   ##
=======================================
  Coverage   89.49%   89.49%           
=======================================
  Files         448      448           
  Lines       84118    84118           
=======================================
  Hits        75282    75282           
  Misses       8836     8836           
Flag Coverage Δ
miri 89.49% <ø> (ø)
unittests 89.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@harsha-simhadri harsha-simhadri marked this pull request as ready for review February 18, 2026 21:36
@harsha-simhadri harsha-simhadri requested review from a team and Copilot February 18, 2026 21:36
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

This PR adds an automated crate publishing workflow for releasing DiskANN crates to crates.io. The workflow can be triggered manually via workflow_dispatch with a dry-run option (default: true) for testing, or automatically when pushing version tags matching v{major}.{minor}.{patch}. The implementation aims to enable safe testing of the release process without actual publication.

Changes:

  • Added .github/workflows/publish.yml workflow with dual-trigger support (tags and manual dispatch)
  • Added .github/PUBLISH_CRATES.md documentation describing the release process and testing procedures
  • Implemented dry-run mode for testing packaging and validation without publishing

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File Description
.github/workflows/publish.yml New GitHub Actions workflow that validates versions, runs tests, and publishes workspace crates with optional dry-run mode
.github/PUBLISH_CRATES.md Comprehensive documentation covering prerequisites, dry-run testing, release steps, and pre-release checklist

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

Comment thread .github/workflows/publish.yml
Comment thread .github/PUBLISH_CRATES.md Outdated
Comment thread .github/workflows/publish.yml
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/workflows/publish.yml
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/workflows/publish.yml
Comment thread .github/workflows/publish.yml
Comment thread .github/PUBLISH_CRATES.md Outdated
Comment thread .github/workflows/publish.yml
Comment thread .github/PUBLISH_CRATES.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
harsha-simhadri and others added 5 commits March 13, 2026 15:21
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread .github/PUBLISH_CRATES.md Outdated

```bash
git checkout main && git pull
git checkout -b release-0.46.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This conflicts with the tags in the PR description and the comments of the workflow yaml. I assume this one should be v0.46.0.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it is 0.46.0 right? Perhaps I pushed after your comment?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So we have both a branch release-X.Y.Z and a tag vX.Y.Z? Why? What is the branch for?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The branch is to update the CArgo.toml right?

Comment thread .github/PUBLISH_CRATES.md Outdated
Comment thread .github/PUBLISH_CRATES.md Outdated
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/workflows/publish.yml
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/workflows/publish.yml
Comment thread .github/workflows/publish.yml Outdated
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/PUBLISH_CRATES.md
Comment thread .github/PUBLISH_CRATES.md Outdated

```bash
git checkout main && git pull
git checkout -b release-0.46.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So we have both a branch release-X.Y.Z and a tag vX.Y.Z? Why? What is the branch for?

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.

Automate crate publishing

6 participants