Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI workflow to publish crates on tag/release #14

Merged
merged 5 commits into from
Jan 21, 2024
Merged

Add CI workflow to publish crates on tag/release #14

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba984e3
Add CI workflow to publish crates on tag/release
mtreinish Jan 11, 2024
0e9a370
Update package dirs after #13 and #15
mtreinish Jan 11, 2024
d80b02a
Update package dirs after #27
jlapeyre Jan 13, 2024
4492956
Choose names that better describe actions taken
jlapeyre Jan 13, 2024
e7a5b00
Put list of crates to release (publish on crates.io) in topo order
jlapeyre Jan 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Release openqasm3_parser
on:
push:
tags:
- '*'

jobs:
publish_crates:
name: Publish openqasm3_parser crates
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
crate: [oq3_lexer, oq3_parser, oq3_syntax, oq3_source_file, oq3_semantics]

steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- name: Run cargo publish
run: |
cd crates/${{ matrix.crate }}
cargo publish
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
Comment on lines +17 to +25
Copy link
Member

Choose a reason for hiding this comment

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

Do the crates get verified crates.io-side at all? If so, we might have to force the order of them to some topological iteration through them to get them uploaded.

Seems a shame that there's no workspace-wide cargo publish.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh that's a good point, yeah we'll need to do this manually in topological order otherwise cargo's validation will error when the dependencies aren't resolvable with crates.io. You get an error like:

error: failed to prepare local package for uploading

Caused by:
  no matching package named `oq3_lexer` found
  location searched: registry `crates-io`

Copy link
Collaborator

Choose a reason for hiding this comment

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

If this is true rust-lang/cargo#1169 (comment) , then there is no problem publishing out of order, as long as the crates have been published once in the correct order (say manually).

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is a ton of discussion around this and many tools available. This tool looks to me (fwiw) to be the most serious and perhaps relevant.
https://github.com/crate-ci/cargo-release