Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better error messages when book and examples are out of sync. #444

Closed
lukeyeh opened this issue Apr 24, 2024 · 1 comment · Fixed by #445
Closed

Better error messages when book and examples are out of sync. #444

lukeyeh opened this issue Apr 24, 2024 · 1 comment · Fixed by #445
Assignees
@ia0
Labels
for:maintainability Improves maintainers life

Comments

@lukeyeh
Copy link
Member

lukeyeh commented Apr 24, 2024

Noticed this while trying to run scripts/ci.sh on some changes that touched examples/. I believe these are the steps causing the issues:

  1. Edit any of some of the examples under examples/ and commit
  2. scripts/ci.sh will run scripts/sync.sh. This will then copy over the example in book to the examples in examples/ and "undo" changes in made in examples/
  3. Now repo isn't clean so we'll hit the error Repository is not clean in scripts/publish.sh

I get the point here (we wan't to keep the book and examples/ in sync), but it took me a while to figure out that some of the scripts were editing the files under me and the error was a little opaque. Maybe we can report error message in sync.sh instead?
ia0 added a commit to ia0/wasefire that referenced this issue Apr 25, 2024
@ia0
Warn and detect edition of generated files
d8522e0 
If the detection happens to have false positive, it will be removed in favor of keeping the warning
only.

Fixes google#444
@ia0 ia0 mentioned this issue Apr 25, 2024
Merged
@ia0
Copy link
Member

ia0 commented Apr 25, 2024 •
edited
Loading

Thanks for the bug report! This is indeed a usability issue for maintainers. I'm fixing it in #445.

@ia0 ia0 added the for:maintainability Improves maintainers life label Apr 25, 2024
@ia0 ia0 self-assigned this Apr 25, 2024
@ia0 ia0 closed this as completed in #445 Apr 25, 2024
ia0 added a commit that referenced this issue Apr 25, 2024
@ia0
Warn and detect edition of generated files (#445)
27ae8a6 
If the detection happens to have false positive, it will be removed in
favor of keeping the warning only.

Fixes #444
chris-dietz pushed a commit to chris-dietz/wasefire that referenced this issue Apr 29, 2024
@ia0 @chris-dietz
Warn and detect edition of generated files (google#445)
f84c186 
If the detection happens to have false positive, it will be removed in
favor of keeping the warning only.

Fixes google#444
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ia0 ia0

Labels
for:maintainability Improves maintainers life
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Warn and detect edition of generated files ia0/wasefire
2 participants
@ia0 @lukeyeh