Maintainability Improvements#671
Closed
carlocorradini wants to merge 6 commits intobytebeamio:mainfrom
Closed
Conversation
Contributor
Author
|
The CI fails due to |
Contributor
|
Hi @carlocorradini, thanks for opening this PR! We would really appreciate it if you could divide the changes included in this PR and open separate PRs to resolve issues at an atomic level. This will help us greatly with the code review process that we adhere to. Here is an example of what the PRs could look like:
In the meanwhile, I will have to close this PR as it is just not feasible for us to review the entirety of this given our extremely constrained bandwidth. Thank you for understanding! 😄 |
This was referenced Aug 7, 2023
Contributor
Author
|
@de-sh No problem |
This was referenced Aug 8, 2023
This file contains hidden or 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
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 PR tries to enhance the overall maintainability of
rumqtt.Note that this PR is not ready to be merged because the code style (
clippy) must be applied to the code.What has been changed:
Stale(bot) is a GitHub actionVSCodecompatibility.rshasfmt/clippy,.shhasprettier/shellcheck, etc...)EditorConfigmarkdownlintPrettierfile formattercspell. A lot of typos have been found and fixedrumqttdDocker image is now based ongcr.io/distroless/cc(from Google) to enhance overall security since "it does not contain package managers, shells or any other programs you would expect to find in a standard Linux distribution"Docker buildx. The new Docker image isarm64(aarch64) andamd64(x86_64)scriptsdirectory). AlsoPOSIXcompliantrumqttverifiersources are now based on Typescript for better maintainability and more. Simply runnpx ts-node path/to/script.tsinstead of oldnode path/to/script.jsaarch64-unknown-linux-gnu->rumqttd-1.0.0-aarch64-unknown-linux-gnuaarch64-unknown-linux-musl->rumqttd-1.0.0-aarch64-unknown-linux-muslx86_64-unknown-linux-gnu->rumqttd-1.0.0-x86_64-unknown-linux-gnux86_64-unknown-linux-musl->rumqttd-1.0.0-x86_64-unknown-linux-muslI need to test
Crossa little bit more but it seems to work without any problem. We could add Windows!Rustversion. I've set it to1.64.0due toCrossrequirement but it can be changed to better suit your needsRustedition is set to2021Please, let me know what you think and what you want to change/update/add/delete 🥳
PS: Thanks for developing
rumqtt*