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

Automate README example generation #289

Merged
merged 17 commits into from
Dec 23, 2024
Merged

Automate README example generation #289

merged 17 commits into from
Dec 23, 2024

Conversation

korotkov-aerospike
Copy link
Contributor

I want to verify that the examples are valid and up to date

@codecov-commenter
Copy link

codecov-commenter commented Dec 23, 2024

Codecov Report

Attention: Patch coverage is 0% with 42 lines in your changes missing coverage. Please review.

Project coverage is 43.94%. Comparing base (270aed5) to head (f62ac9c).

Files with missing lines Patch % Lines
build/readme/readme_example_generator.go 0.00% 40 Missing ⚠️
pkg/dto/restore_request.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##               v2     #289      +/-   ##
==========================================
- Coverage   44.57%   43.94%   -0.63%     
==========================================
  Files          51       52       +1     
  Lines        2809     2849      +40     
==========================================
  Hits         1252     1252              
- Misses       1432     1472      +40     
  Partials      125      125              

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

@korotkov-aerospike korotkov-aerospike marked this pull request as ready for review December 23, 2024 11:19
@reugn reugn changed the title Generate examples int README.md with code Automate README example generation Dec 23, 2024
Copy link
Member

@reugn reugn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great initiative to automate example generation.

@@ -0,0 +1,196 @@
package main
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relocate the script under build/readme.

@korotkov-aerospike korotkov-aerospike merged commit 0dce781 into v2 Dec 23, 2024
7 checks passed
@korotkov-aerospike korotkov-aerospike deleted the readme branch December 23, 2024 13:32
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.

3 participants