Improve CI

[Roms1383]

Related to #5

[Roms1383]

I have a suggestion regarding the publish crate job in main release workflow: usually you might want to run everything on every commit (check / build / format / lint) and only run release related job steps on main once all the other jobs have succeeded. Would you like me to make the appropriate changes in that regard ?

[Odonno]

Hi @Roms1383

Thank you for tackling this issue. With your help, I want to improve the whole CI, improve quality/reliability and reduce build time as much as possible.

Indeed, I want the publish crate to run once everything succeed. That's why it's the last command in the job. I suppose you want to make a separate/dependent job? If so, feel free to do so.

I already have some question regarding the current state of your PR:

• Should the cargo config file be named config.toml? (I see the extension is missing)
• Is git-fetch-with-cli = true supposed to fix the error: failed to verify the checksum of surrealdb v1.0.0-beta.9+20230402 error?
• I hope it is not too much to ask but format and lint are currently not parts of the CI. Is it possible for you to add them?
• Same question for check step if you think that's necessary to add it

Anyway, thanks again for doing this.

[Roms1383]

Should the cargo config file be named config.toml? (I see the extension is missing)

cargo actually reads both (see config), but you're right the preferred one is with .toml so I updated it.

Is git-fetch-with-cli = true supposed to fix the error: failed to verify the checksum of surrealdb v1.0.0-beta.9+20230402 error?

Yes, as far as I remember there's an issue with semver in dependencies version at the moment. I fixed it on my repo by temporarily specifying this and the git path (see e1becfd).

I hope it is not too much to ask but format and lint are currently not parts of the CI. Is it possible for you to add them?

Of course! :)

Same question for check step if you think that's necessary to add it

Added it too!

[Roms1383]

By the way you don't necessarily need to use char emoji directly in commit messages, but you can type them as text like:emoji: instead : see gitmoji.

[Roms1383]

How do you usually like to trigger releases ?
By committing a tag on main branch, or via Github releases ?

[Odonno]

By the way you don't necessarily need to use char emoji directly in commit messages, but you can type them as text like:emoji: instead : see gitmoji.

I am a lazy guy, I click on the icon to copy/paste the emoji.

[Odonno]

How do you usually like to trigger releases ? By committing a tag on main branch, or via Github releases ?

My current process is the following:

• Change the version in Cargo.toml via a commit, and publish a new crate version only if a new version is detected on main branch (main workflow)
• Manually create a GitHub release following the pushed commit to main

I am comfortable to have a manual process for the moment. I could change it if you have an interesting solution.

[Roms1383]

Mine is similar:

• bump version in Cargo.toml on main, then commit + push
• add tag on main then commit + push and let workflows do the rest (build > bundle artifacts > create draft github release)

and if everything goes fine I manually update the draft release to a published release.

For example in this release workflow.

[Odonno]

So, you want to move the publish crate step to the release workflow? If this is your idea, I am ok doing that.

[Roms1383]

Ready for review @Odonno 🎉
CI is running on fork over there.

[Roms1383]

As a side note, a recurrent warning in the console inform that license-file and license keys are redundant in Cargo.toml : whichever would you like to keep ?

[Odonno]

As a side note, a recurrent warning in the console inform that license-file and license keys are redundant in Cargo.toml : whichever would you like to keep ?

Yes, I know. I started to play with license-file but instead of showing MIT in the crates.io website, it showed unknown or something like that. I added license = MIT to force the display of MIT on this website. Not sure what is the best option.

[Roms1383]

You could just keep license = MIT without deleting the LICENSE file at the root of the repo, maybe ?
This way crates.io shows up correctly and user still have access to your LICENSE file.
or just look at how other popular crates out there handle that :)
It's out of the scope of this PR anyway.

As you can see from last 2 Actions runs, we're green & ready for review ! 🚀

[Odonno]

You could just keep license = MIT without deleting the LICENSE file at the root of the repo, maybe ? This way crates.io shows up correctly and user still have access to your LICENSE file. or just look at how other popular crates out there handle that :) It's out of the scope of this PR anyway.

As you can see from last 2 Actions runs, we're green & ready for review ! 🚀

Review is done. There are many changes in this PR so I detected some things to change.

I will remove license-file property then.

[Odonno]

I think we are close to the end. 👍

[Odonno]

Seems good to me. Thank you for your effort.