crate publishing workflow by Copilot · Pull Request #755 · microsoft/DiskANN

Copilot · 2026-02-10T16:29:32Z

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)

Fixes Automate crate publishing #752

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

Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>

codecov-commenter · 2026-02-17T20:32:42Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.11%. Comparing base (3674a49) to head (9b8611d).
⚠️ Report is 41 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #755      +/-   ##
==========================================
+ Coverage   88.99%   89.11%   +0.11%     
==========================================
  Files         428      443      +15     
  Lines       78234    83354    +5120     
==========================================
+ Hits        69626    74281    +4655     
- Misses       8608     9073     +465

Flag	Coverage Δ
miri	`89.11% <ø> (+0.11%)`	⬆️
unittests	`88.95% <ø> (-0.05%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 168 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

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.

.github/workflows/publish.yml

.github/PUBLISH_CRATES.md

.github/workflows/publish.yml

.github/PUBLISH_CRATES.md

.github/workflows/publish.yml

.github/PUBLISH_CRATES.md

Copilot · 2026-02-18T21:41:56Z

.github/workflows/publish.yml

+          CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+        run: |
+          DRY_RUN_FLAG=""
+          if [ "${{ github.event.inputs.dry_run || 'false' }}" = "true" ]; then


The dry-run default expression github.event.inputs.dry_run || 'false' will evaluate to 'false' when the workflow is triggered by a tag push (since github.event.inputs.dry_run will be empty/null). This is correct behavior for tag-triggered publishes. However, consider making this more explicit with a comment or using a more readable approach like setting a workflow-level environment variable that checks both the trigger type and input.

Suggested change

if [ "${{ github.event.inputs.dry_run || 'false' }}" = "true" ]; then

# For tag-push events, github.event.inputs.dry_run is empty, so this evaluates to a real (non-dry-run) publish.

if [ "${{ github.event.inputs.dry_run }}" = "true" ]; then

.github/workflows/publish.yml

hildebrandmw · 2026-02-18T22:24:39Z

.github/PUBLISH_CRATES.md

+   cargo search diskann --limit 20
+   ```
+
+### Example Pre-Release Flow


This recommends pushing directly to main, which we can't do due to branch protection rules.

Instead, we should use this workflow:

Checkout main, bump the version and push.

Make a pull-request out of the version bumped commit.

Use the dry-run as a pre-merge check.

Merge the PR and use the github UI to tag the release along with change notes.

I think I addressed this oversight

.github/workflows/publish.yml

hildebrandmw · 2026-02-18T22:34:47Z

.github/PUBLISH_CRATES.md

+
+### What It Does NOT Test
+
+- Actual publishing, registry token auth, upload reliability


We may want to mention what to do if the publish step fails. Basically, we either need to manually fix and publish the remaining crates, or fix the publish issue, bump the version number, and bump again (or if the fix doesn't change the versions that succeeded, then the remaining ones can be updated and pushed potentially in the same release).

If the publishing fails part way through for networking issues, then we'll need to handle the remaining ones manually.

I am not certain of the behavior. Coudl it be that running the action again uploads missing crate? can we handle this when it happens?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

metajack · 2026-03-13T23:55:31Z

.github/PUBLISH_CRATES.md

+
+   ```bash
+   git checkout main && git pull
+   git checkout -b release-0.46.0


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.

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

metajack · 2026-03-13T23:56:07Z

.github/PUBLISH_CRATES.md

+   version = "0.46.0"
+   ```
+
+   All workspace crates inherit this via `version.workspace = true`.


Don't all the other crate versions also need updating?

I think all creates are inheriting via version.workspace=true.

Do you mean we should update the versions under workspace.dependcies? I can add a check to ensure they all align with the version being published if thats what you meant?

I added a step in publishing instructions to advise.
shall I add something like this to the CI to automate testing

- name: Verify workspace dependency versions match workspace.package.version run: | WORKSPACE_VERSION=$(sed -n '/\[workspace\.package\]/,/^\[/{ s/^version *= *"$.*$"/\1/p }' Cargo.toml) echo "workspace.package.version = $WORKSPACE_VERSION" mismatched=() while IFS= read -r line; do crate=$(echo "$line" | sed 's/\s*=.*//') if echo "$line" | grep -q "path\s*=" && echo "$line" | grep -qv "version\s*=\s*\"$WORKSPACE_VERSION\""; then mismatched+=("$crate") fi done < <(sed -n '/\[workspace\.dependencies\]/,/^\[/{/^\[/d;/^#/d;/^$/d;p}' Cargo.toml) if [ ${#mismatched[@]} -gt 0 ]; then echo "::error::The following workspace dependencies have a version that does not match $WORKSPACE_VERSION: ${mismatched[*]}" exit 1 fi ```

metajack · 2026-03-13T23:56:31Z

.github/PUBLISH_CRATES.md

+
+   ```bash
+   git commit -am "Bump version to 0.46.0"
+   git push origin release-0.46.0


Tag wrong here as well.

sorry, is the version syntax wrong or the concrete number wrong? this is just an example, right?

metajack · 2026-03-13T23:57:00Z

.github/PUBLISH_CRATES.md

+
+6. **Merge the PR** into `main`.
+
+7. **Create a release** via the GitHub UI:


Is this not automatable?

You mean publish crate whenever a PR with new version is merged to main? Possibly. Being a bit conservative for now

.github/PUBLISH_CRATES.md

metajack · 2026-03-14T00:00:02Z

.github/workflows/publish.yml

+    name: >-
+      ${{
+        github.event_name == 'pull_request'
+          && 'Dry-run publish test'


What do these strings evaluate as or do? I don't understand the test condition.

removed unnecessary clauses

.github/workflows/publish.yml

Initial plan

96952ee

Copilot AI assigned Copilot and harsha-simhadri Feb 10, 2026

Copilot started work on behalf of harsha-simhadri February 10, 2026 16:29 View session

Copilot AI and others added 4 commits February 10, 2026 16:32

Add automated crate publishing workflow and documentation

6affcd3

Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>

Fix crate publish order to respect all dependencies

f717d30

Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>

Add release information to README with crates.io badge

52849b1

Co-authored-by: harsha-simhadri <5590673+harsha-simhadri@users.noreply.github.com>

Fix grep pattern for crate search and improve rollback documentation

4710c0d

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

Copilot finished work on behalf of harsha-simhadri February 10, 2026 16:39

Copilot AI requested a review from harsha-simhadri February 10, 2026 16:39

Copilot started work on behalf of harsha-simhadri February 10, 2026 21:15 View session

Add dry-run testing capability to publish workflow

556f9af

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

Copilot finished work on behalf of harsha-simhadri February 10, 2026 21:19

reduce changes

0759b3c

harsha-simhadri changed the title ~~Add dry-run testing for crate publishing workflow~~ crate publishing workflow Feb 17, 2026

harsha-simhadri requested a review from metajack February 17, 2026 20:22

use workspace publishing

24b706a

harsha-simhadri marked this pull request as ready for review February 18, 2026 21:36

harsha-simhadri requested review from a team and Copilot February 18, 2026 21:36

Copilot started reviewing on behalf of harsha-simhadri February 18, 2026 21:37 View session

Copilot AI reviewed Feb 18, 2026

View reviewed changes

hildebrandmw reviewed Feb 18, 2026

View reviewed changes

Copilot stopped work on behalf of harsha-simhadri due to an error March 13, 2026 21:24
Before you can use Copilot coding agent, you need to pick a "Usage billed to" option in your Copilot settings. Update your settings at https://github.com/settings/copilot/features, then try again.

Copilot stopped work on behalf of harsha-simhadri due to an error March 13, 2026 21:45
Before you can use Copilot coding agent, you need to pick a "Usage billed to" option in your Copilot settings. Update your settings at https://github.com/settings/copilot/features, then try again.

Apply suggestion from @Copilot

11eee5b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot started work on behalf of harsha-simhadri March 13, 2026 21:58 View session

Copilot stopped work on behalf of harsha-simhadri due to an error March 13, 2026 21:59
Copilot has encountered an error. See logs for additional details.

harsha-simhadri and others added 5 commits March 13, 2026 15:21

modify the workflow to dry run on PR and publish on tag after PR merge

b300f77

prevent publish from non main branch

db5b6ed

Apply suggestion from @Copilot

b5fb444

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

dry run flag

d6d61f9

Apply suggestion from @Copilot

2da92af

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

metajack requested changes Mar 14, 2026

View reviewed changes

harsha-simhadri added 5 commits March 13, 2026 17:37

error fix and more validations

7b31be4

specify what to verify after publishing

d7b3e87

add dep version matching instuction, and change rust-toolchain config

37f755c

removed another round of tests

21363c6

simplify conditional in CI

9b8611d

	if [ "${{ github.event.inputs.dry_run \|\| 'false' }}" = "true" ]; then
	# For tag-push events, github.event.inputs.dry_run is empty, so this evaluates to a real (non-dry-run) publish.
	if [ "${{ github.event.inputs.dry_run }}" = "true" ]; then


		### What It Does NOT Test

		- Actual publishing, registry token auth, upload reliability


		6. Merge the PR into `main`.

		7. Create a release via the GitHub UI:

Conversation

Copilot AI commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

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

Uh oh!

codecov-commenter commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harsha-simhadri Mar 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Copilot AI commented Feb 10, 2026 •

edited

Loading

codecov-commenter commented Feb 17, 2026 •

edited

Loading

harsha-simhadri Mar 14, 2026 •

edited

Loading