[Enhancement] Add Special Handling of Rust Project Files; fixes #390 #413
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
|
kevinmatthes
commented
Jun 28, 2023
|
As you already mentioned in #390, some warning messages should be printed in case that the version increment should fail. I agree with you and will add them, in the following. But in contrast to exiting with code zero for "okay", I would prefer to make the workflow calling Aeruginous fail as any of the of the reasons for the version increment to fail indicates major problems which should be solved even before generating the RONLOG / CHANGELOG because their resolution might be relevant enough for being documented in there. Thus, I would like to suggest to leave the non-zero exiting behaviour in as a feature. Furthermore, this would prevent the tracked files from becoming out of sync as the code base will be left in an undefined state if the version increment should fail; it is not always possible to check for the version increment to succeed beforehand as some error conditions are rather random. Having to restart the entire workflow in case of an error will make sure that the code base will always be in a defined and known state. |
|
|
|
|
|
|
|
|
I added error messages to the logic; the keywords are highlighted in red. |
|
@kevinmatthes Blocking the pipeline because Aeruginous can't increase the version without giving an option to increase the version manually could block a release until changing the release pipeline itself and removing increase-version command from within the .yml file and the bring it back after that. |
|
|
|
|
|
|
I implemented the changes you requested regarding the updating logic; you are now free to choose whether you would like to update or to rewrite the Cargo.toml, defaulting to a simple update without reformatting the file. Regarding the exit codes in error cases, I disagree with you. If Aeruginous should consider the situation impossible to continue, it is most likely that either:
These reasons are nearly impossibly rare if:
Since these three conditions can be safely expected to be the normal style of developing a Rust project, the version increment on Cargo.lock and Cargo.toml would only fail if there are fundamental problems with the project's code base which require urgent fixes. In addition to the error conditions named above, there are also the usual file IO errors which can happen with any software and the simplest way fixing them is to check if the software is called correctly and to try again. Everything else is a bug which requires a bug report and deserves a fix. |
|
If you would like to continue the discussion on possible error causes during the release preparations, i.e. the RONLOG assembly, which might cause Aeruginous to block the release pipeline, please create a discussion of type "General" in the "Discussions" tab and explain the challenges you see with a concrete example. |
|
@kevinmatthes |
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.
No description provided.