Prepare crates for publishing #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the openqasm3_parser project for publishing crates. Primarily this involves unifying the packaging metadata between all the crates in the workspace. The other big change is all the crates and library names are renamed to have a `oq3_` prefix with the exception of qasm3_bytecode because it already had a descriptive name that was unlikely to conflict with anything.
jakelishman
reviewed
Jan 11, 2024
There was a problem hiding this comment.
Mostly this looks fine to me. Good to strip the "MIT or " bit from the license, since I don't think we're allowed to have it as part of our OSS strategy.
Do we have a formal requirement to include the same Apache-2.0-ish header on all source files in the distribution package, since crates.io involves us distributing the source files? My approximately understanding was that Apache 2.0 doesn't require it (and explicitly says you shouldn't include the copyright bit for ASF-developed stuff), but I think we might have different rules internally?
Could we unify all the directories for the source files to be oq3_ prefixed for consistency with their package names? I commented on a couple but not all.
mtreinish
added a commit
to mtreinish/openqasm3_parser
that referenced
this pull request
Jan 11, 2024
jakelishman
approved these changes
Jan 11, 2024
* Fix merge conflicts. * Minor clean up
jlapeyre
added a commit
that referenced
this pull request
Jan 21, 2024
* Add CI workflow to publish crates on tag/release This commit adds a new github actions work to publish the package's crates to crates.io. This new CI job run cargo publish on the respective crates in the correct order to publish the entire workspace. * Update package dirs after #13 and #15 * Update package dirs after #27 * Choose names that better describe actions taken * Put list of crates to release (publish on crates.io) in topo order --------- Co-authored-by: John Lapeyre <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the openqasm3_parser project for publishing crates. Primarily this involves unifying the packaging metadata between all the crates in the workspace. The other big change is all the crates and library names are renamed to have a
oq3_prefix with the exception of qasm3_bytecode because it already had a descriptive name that was unlikely to conflict with anything.