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.

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

Add -generated-notice, as suggested by #99Add -generated-file-notice, as suggested by #99 #132

Merged
merged 3 commits into from
Apr 3, 2024
Merged

Add -generated-notice, as suggested by #99Add -generated-file-notice, as suggested by #99 #132

merged 3 commits into from
Apr 3, 2024

Conversation

alexandregv
Copy link
Contributor

As suggested by #99, this PR adds a new flag allowing to add a "Generated file" notice in the raw README, via a HTML comment.
This makes the comment invisible in rendered Markdown, but visible when editing the raw file.

CLI flag is -generated-notice and JSON field is generated_notice.
Default value is false (compatible with current behavior).

I feel like this one could be true by default. If true by default, I'm not sure how to implement it with the JSON config, or if I should change it to something like skip-generated-notice?

Any opinion/idea is welcome.

Test has been added too.

Closes #99

Copy link

codecov bot commented Mar 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.87%. Comparing base (8283e66) to head (03a0d61).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #132   +/-   ##
=======================================
  Coverage   69.87%   69.87%           
=======================================
  Files           3        3           
  Lines          83       83           
=======================================
  Hits           58       58           
  Misses         15       15           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@posener posener merged commit bd09b68 into posener:master Apr 3, 2024
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated file notice in raw MD file
2 participants