automate crate publishing #238

maxcountryman · 2020-07-25T15:07:54Z

This introduces a new section of the GitHub Actions workflow which will
publish the crate upon a new tag being pushed. Note that this requires a
new project secret, CRATES_TOKEN.

This introduces a new section of the GitHub Actions workflow which will publish the crate upon a new tag being pushed. Note that this requires a new project secret, `CRATES_TOKEN`.

coveralls · 2020-07-25T15:10:00Z

Pull Request Test Coverage Report for Build 191280814

0 of 0 changed or added relevant lines in 0 files are covered.
255 unchanged lines in 6 files lost coverage.
Overall coverage increased (+0.2%) to 91.849%

Files with Coverage Reduction	New Missed Lines	%
tests/sqlparser_mysql.rs	1	98.67%
src/ast/ddl.rs	14	83.33%
tests/sqlparser_common.rs	25	96.82%
src/tokenizer.rs	32	91.89%
src/ast/mod.rs	54	79.86%
src/parser.rs	129	88.93%

Totals
Change from base Build 175941714:	0.2%
Covered Lines:	4440
Relevant Lines:	4834

💛 - Coveralls

maxcountryman · 2020-07-25T15:10:51Z

@nickolay or @andygrove, if one of you could add the CRATES_TOKEN to the project secrets then this should be good to go. 🙂

Dandandan · 2020-07-25T16:30:50Z

@maxcountryman maybe could use some docs/instructions to describe how to publish (pushing with the right tags)

nickolay · 2020-07-27T07:28:45Z

I don't think I have the rights to do that.

maxcountryman · 2020-07-27T22:41:16Z

@maxcountryman maybe could use some docs/instructions to describe how to publish (pushing with the right tags)

Yep--I wonder where best to keep that?

andygrove · 2020-07-28T15:05:30Z

@maxcountryman I've temporarily made you an admin on the repo

maxcountryman · 2020-07-28T15:48:42Z

Thanks @andygrove, I created a new token and added it to the repo secrets. I shouldn't need admin access any longer.

Dandandan · 2020-07-31T14:53:10Z

@maxcountryman maybe could use some docs/instructions to describe how to publish (pushing with the right tags)

Yep--I wonder where best to keep that?

Maybe a new file like RELEASING.md?

maxcountryman · 2020-07-31T14:54:47Z

@maxcountryman maybe could use some docs/instructions to describe how to publish (pushing with the right tags)

Yep--I wonder where best to keep that?

Maybe a new file like RELEASING.md?

Sure. I can add something to this PR.

maxcountryman · 2020-07-31T16:12:08Z

I noticed our tags are named slightly inconsistently. Does anyone have a strong preference or could be move towards omitting the v prefix? (It shouldn't make a difference for automation, but I figured as long as we're documenting the process we could establish a consistent pattern.)

Dandandan · 2020-07-31T16:31:52Z

Without v sounds good to me

maxcountryman · 2020-07-31T16:42:46Z

@nickolay can I just check you're all right with this methodology? I don't want to commit us to this process without everyone's buy-in. 🙂

nickolay · 2020-07-31T17:02:40Z

Push-to-publish is great!
I have no opinion about vX.Y vs X.Y for the tag names.
As for the documentation, the process to update the version number on master is not documented (I think Andy uses some tool for that?), including a reminder to follow semver, as described in CHANGELOG.md.

Thanks!

maxcountryman · 2020-07-31T17:06:02Z

As for the documentation, the process to update the version number on master is not documented (I think Andy uses some tool for that?), including a reminder to follow semver, as described in CHANGELOG.md.

Thanks for pointing that out. @andygrove would you mind sharing the process/tool we should use for that? I can update the release doc accordingly.

andygrove · 2020-07-31T17:28:50Z

I've been using cargo release. https://github.com/sunng87/cargo-release

…

On Fri, Jul 31, 2020 at 11:06 AM Max Countryman ***@***.***> wrote: As for the documentation, the process to update the version number on master is not documented (I think Andy uses some tool for that?), including a reminder to follow semver, as described in CHANGELOG.md. Thanks for pointing that out. @andygrove <https://github.com/andygrove> would you mind sharing the process/tool we should use for that? I can update the release doc accordingly. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#238 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHEBRFV2PXPK7QXTODLYLTR6L2YVANCNFSM4PHP7BWQ> .

Cargo.toml

nickolay · 2020-08-02T14:04:02Z

docs/releasing.md


 ## Process

-Please ensure you follow the correct format when creating new tags. For
-instance:
+Using `cargo-release` we can author a new minor release like so:


I'm not thinking of the new releases as "minor", so perhaps it would be useful to remind that this means 0.(N+1) in our context?

Sure that makes sense to me. Maybe we should simply link to the CHANGELOG where that's described?

Sure, but CHANGELOG doesn't mention "minor" releases either. Technically, "minor" is the correct term with regards to semver, but in context of sqlparser using it without mentioning semver is slightly weird. Do what you think is best, I don't have a strong opinion on if or how this should be addressed.

I'll leave this as-is for now.

Dandandan · 2020-08-10T16:04:10Z

Anything that remains on this one? Would like to see this in action!

nickolay · 2020-08-10T16:16:46Z

I was wondering about that as well!

A couple of ideas for the future:

I noticed that the publish-crate "check" is displayed as "skipped" on this PR. Is it at all possible to only run it on pushes to certain tags (the docs seem to say so)?
When/if Support a release action actions-rs/meta#6 is resolved we should consider using the standardized solution.

Dandandan · 2020-08-11T18:55:25Z

I was wondering about that as well!

A couple of ideas for the future:

I noticed that the publish-crate "check" is displayed as "skipped" on this PR. Is it at all possible to only run it on pushes to certain tags (the docs seem to say so)?

When/if actions-rs/meta#6 is resolved we should consider using the standardized solution.

I like the idea of making this only on a tag! I think it has to move to a new workflow/file in that case.
Also, indeed might make a note to use that in the future.

maxcountryman · 2020-08-11T19:17:54Z

Sorry, I haven't had a chance to get back to this. I'll take another look this evening--those all sound like good ideas but perhaps we can circle back and prioritize getting this live first?

nickolay · 2020-08-11T19:31:40Z

prioritize getting this live first?

Sure, this is exactly what I meant by calling my notes "ideas for the future"!

maxcountryman · 2020-08-12T14:05:23Z

All right, this is merged. Hopefully I configured it correctly. 🤞

nickolay · 2020-08-13T01:34:59Z

Great! I pushed a PR updating the changelog (#261) so that we can test out the new release procedure.

I also unresolved my comments above, so that they would be visible by default, if you don't mind.

nickolay · 2020-08-14T19:51:34Z

Continuing from #238 (comment)

I noticed our tags are named slightly inconsistently. Does anyone have a strong preference or could be move towards omitting the v prefix? (It shouldn't make a difference for automation, but I figured as long as we're documenting the process we could establish a consistent pattern.)

it seems you didn't implement this? I'll note that the newer tags start with v due to a change in cargo-release. They claim that the "v" prefix is more common.

[edit] also note that future changes are being discussed in #263

maxcountryman · 2020-08-14T20:20:55Z

Continuing from #238 (comment)

I noticed our tags are named slightly inconsistently. Does anyone have a strong preference or could be move towards omitting the v prefix? (It shouldn't make a difference for automation, but I figured as long as we're documenting the process we could establish a consistent pattern.)

it seems you didn't implement this? I'll note that the newer tags start with v due to a change in cargo-release. They claim that the "v" prefix is more common.

[edit] also note that future changes are being discussed in #263

I'm not sure I follow? I implemented what Andy had suggested, which I believe was to use cargo release. So the naming is handled by cargo release now.

nickolay · 2020-08-14T20:41:02Z

Andy didn't say anything about the naming of tags. Older cargo-release used to create X.Y tags and the current version creates vX.Y tags, which explains the inconsistency you found.

You initially intended to standardize on using tags named "X.Y" and even put git push origin 0.6.0 in docs/releasing.md, while the current version of cargo-release creates tags named vX.Y as we didn't configure it to do otherwise. We should either accept the cargo-release's new default and update the docs, or add the configuration to Cargo.toml, so that cargo-release creates X.Y (sans the v prefix) tags.

automate crate publishing

bc9bfae

This introduces a new section of the GitHub Actions workflow which will publish the crate upon a new tag being pushed. Note that this requires a new project secret, `CRATES_TOKEN`.

document initial release process

1a70c6e

maxcountryman requested a review from Dandandan July 31, 2020 16:19

fix typo

6b37c16

update release instructions

9351efb

maxcountryman requested a review from nickolay August 2, 2020 13:53

nickolay reviewed Aug 2, 2020

View reviewed changes

Dandandan approved these changes Aug 7, 2020

View reviewed changes

maxcountryman merged commit 118a345 into apache:main Aug 12, 2020

maxcountryman deleted the feature/gh-action-releases branch August 12, 2020 14:04

Wenzel mentioned this pull request Dec 14, 2020

First publication on crates.io Wenzel/libmicrovmi#108

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

automate crate publishing #238

automate crate publishing #238

maxcountryman commented Jul 25, 2020

coveralls commented Jul 25, 2020 •

edited

Loading

maxcountryman commented Jul 25, 2020

Dandandan commented Jul 25, 2020

nickolay commented Jul 27, 2020

maxcountryman commented Jul 27, 2020

andygrove commented Jul 28, 2020

maxcountryman commented Jul 28, 2020

Dandandan commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

maxcountryman commented Jul 31, 2020 •

edited

Loading

Dandandan commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

nickolay commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

andygrove commented Jul 31, 2020 via email

nickolay Aug 2, 2020

maxcountryman Aug 2, 2020

nickolay Aug 2, 2020

maxcountryman Aug 12, 2020

Dandandan commented Aug 10, 2020

nickolay commented Aug 10, 2020

Dandandan commented Aug 11, 2020

maxcountryman commented Aug 11, 2020

nickolay commented Aug 11, 2020

maxcountryman commented Aug 12, 2020

nickolay commented Aug 13, 2020

nickolay commented Aug 14, 2020 •

edited

Loading

maxcountryman commented Aug 14, 2020

nickolay commented Aug 14, 2020

automate crate publishing #238

automate crate publishing #238

Conversation

maxcountryman commented Jul 25, 2020

coveralls commented Jul 25, 2020 • edited Loading

Pull Request Test Coverage Report for Build 191280814

💛 - Coveralls

maxcountryman commented Jul 25, 2020

Dandandan commented Jul 25, 2020

nickolay commented Jul 27, 2020

maxcountryman commented Jul 27, 2020

andygrove commented Jul 28, 2020

maxcountryman commented Jul 28, 2020

Dandandan commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

maxcountryman commented Jul 31, 2020 • edited Loading

Dandandan commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

nickolay commented Jul 31, 2020

maxcountryman commented Jul 31, 2020

andygrove commented Jul 31, 2020 via email

nickolay Aug 2, 2020

Choose a reason for hiding this comment

maxcountryman Aug 2, 2020

Choose a reason for hiding this comment

nickolay Aug 2, 2020

Choose a reason for hiding this comment

maxcountryman Aug 12, 2020

Choose a reason for hiding this comment

Dandandan commented Aug 10, 2020

nickolay commented Aug 10, 2020

Dandandan commented Aug 11, 2020

maxcountryman commented Aug 11, 2020

nickolay commented Aug 11, 2020

maxcountryman commented Aug 12, 2020

nickolay commented Aug 13, 2020

nickolay commented Aug 14, 2020 • edited Loading

maxcountryman commented Aug 14, 2020

nickolay commented Aug 14, 2020

coveralls commented Jul 25, 2020 •

edited

Loading

maxcountryman commented Jul 31, 2020 •

edited

Loading

nickolay commented Aug 14, 2020 •

edited

Loading