Validate git is clean when publishing #4373
Merged
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
jonasfj
reviewed
Sep 6, 2024
lib/src/validator/git_status.dart
Outdated
| import '../utils.dart'; | ||
| import '../validator.dart'; | ||
|
|
||
| /// A validator that validates that no checked in files are modiofied in git. |
There was a problem hiding this comment.
Suggested change
| /// A validator that validates that no checked in files are modiofied in git. | |
| /// A validator that validates that no checked in files are modified in git. |
lib/src/validator/git_status.dart
Outdated
| class GitStatusValidator extends Validator { | ||
| @override | ||
| Future<void> validate() async { | ||
| if (package.inGitRepo) { |
There was a problem hiding this comment.
nit: please return early instead of nesting a bit more 🤣
Suggested change
| if (package.inGitRepo) { | |
| if (package.inGitRepo) { | |
| return; | |
| } |
lib/src/validator/git_status.dart
Outdated
Comment on lines
46
to
49
| for (var i = 0; i < output.length; i++) { | ||
| if (output[i] != 0) { | ||
| continue; | ||
| } |
There was a problem hiding this comment.
Perhaps consider splitting this out into a helper library.. git.parseMachineStatus or something.
This might be worth having unit tests cover.
There was a problem hiding this comment.
I split something out - but it is hard to make something really general I think...
lib/src/validator/git_status.dart
Outdated
| if (output[i] != 0) { | ||
| continue; | ||
| } | ||
| final filename = utf8.decode( |
There was a problem hiding this comment.
you might want to handle FormatException
jonasfj
approved these changes
Sep 9, 2024
| /// The first [skipPrefix] bytes of each substring will be ignored (useful for | ||
| /// `git status -z`). If there are not enough bytes to skip, throws a | ||
| /// [FormatException]. | ||
| List<Uint8List> splitZeroTerminated(Uint8List output, {int skipPrefix = 0}) { |
There was a problem hiding this comment.
splitZeroTerminated without the skipPrefix might have been more sane.
But this is also fine :D
There was a problem hiding this comment.
Yeah - more sane - just I wanted to avoid creating too much garbage, and (as far as I can tell) utf8.decode cannot work on a partial buffer...
srawlins
added a commit
to srawlins/dartdoc
that referenced
this pull request
Oct 2, 2024
These files can have minor differences in them (depending on the version of Dart?), so that it is difficult for them to always be identical to the ones checked in, during CI. Then there is a new warning that `pub publish --dry-run` produces, if the current git checkout is not clean: dart-lang/pub#4373. We need to reset these files to avoid that warning.
Merged
1 task
srawlins
added a commit
to dart-lang/dartdoc
that referenced
this pull request
Oct 3, 2024
…sh (#3896) These files can have minor differences in them (depending on the version of Dart?), so that it is difficult for them to always be identical to the ones checked in, during CI. Then there is a new warning that `pub publish --dry-run` produces, if the current git checkout is not clean: dart-lang/pub#4373. We need to reset these files to avoid that warning.
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.
Fixes #2040
Does not warn about newly added files, because they might get generated by a build step.