Add Basic CI/CD

[yonipeleg33]

Hello there!

1. Currently, running cargo clippy yields:

...
error: aborting due to 4 previous errors; 56 warnings emitted

2. No formatting is enforced on new PRs.
3. Currently, there's no way of using pq without building it locally afaik, which can be a huge drawback.

Suggestion:

1. Fix all clippy warnings / errors
2. Add a GitHub Action that runs cargo clippy, cargo fmt, make test-all and make test-e2e on every PR and push to master
3. Add a GitHub Action that publishes to crates.io so that one can install it using cargo install pq (and consider packaging it to apt and such, I offered crates.io as it's the easiest option I think)

[iximiuz]

Seems like the crate name pq is already taken. I added a workaround cargo install --git https://github.com/iximiuz/pq to README, but I'd appreciate any suggestions of a better solution.

For the GitHub actions part, I added cargo fmt and cargo test. I'm looking how to add the clippy check.

[yonip23]

Mmm idk what to do with the existing name, maybe pq-rs is free?

About the clippy, it should be quite trivial to do it in gh actions, lmk if you need any help

[iximiuz]

Ok, we have all the basic checks in the action now - fmt, test, and clippy.

[yonip23]

👑
All that's left is the crates.io issue then?

[iximiuz]

Yeah, although I'm still not sure about the crate name. pq-rs sounds good, but not ideal 😃

[yonip23]

Btw Im afk now, so if you want to try and run cargo fmt/clippy --all-targets, I'm not sure that all of the code is covered by default (examples, tests etc.)

[yonip23]

Yeah, although I'm still not sure about the crate name. pq-rs sounds good, but not ideal 😃

I get you, but it's quite classic to add rs to crate names. There are tons of crates with this postfix. Your call of course 🙂

[iximiuz]

Indeed, cargo clippy doesn't check tests by default. Updated the action yaml.

For the name, I need to sleep on it first 😄

[yonip23]

Sure

While you're at it, would be great if you could open another issue or two with a description of what needs to be done (and maybe some hints where to start)😊

[iximiuz]

Just added one #6. I have plenty of ideas but most of them are too vague for a good first issue. I'll see how I could formalize and decompose them.

[yonip23]

Nice, will look into it soon :)