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
[OE] Adds dev doc script to precommit hook #6585
Open
ashwin-pc
wants to merge
7
commits into
opensearch-project:main
Choose a base branch
from
ashwin-pc:docs/update-dev-docs-list
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
[OE] Adds dev doc script to precommit hook #6585
ashwin-pc
wants to merge
7
commits into
opensearch-project:main
from
ashwin-pc:docs/update-dev-docs-list
+66
−15
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
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
ashwin-pc
requested review from
ananzh,
kavilla,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
curq,
bandinib-amzn,
SuZhou-Joe,
ruanyl,
BionIT and
xinruiba
as code owners
April 22, 2024 09:30
SuZhou-Joe
previously approved these changes
Apr 23, 2024
ashwin-pc
commented
Apr 23, 2024
Signed-off-by: Ashwin P Chandran <ashwinpc1993@gmail.com>
AMoo-Miki
reviewed
Apr 23, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6585 +/- ##
=======================================
Coverage 67.70% 67.70%
=======================================
Files 3417 3417
Lines 66922 66922
Branches 10888 10888
=======================================
+ Hits 45310 45311 +1
Misses 18966 18966
+ Partials 2646 2645 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Co-authored-by: Miki <amoo_miki@yahoo.com> Signed-off-by: Ashwin P Chandran <ashwinpc1993@gmail.com>
SuZhou-Joe
previously approved these changes
Apr 24, 2024
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
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.
Description
Adds dev doc generation script to the precommit hook. It also validates that it is staged and fails if there is a diff and the diff isnt staged.
Issues Resolved
Screenshot
Testing the changes
yarn docs:generateDevDocs
Changelog
Check List
yarn test:jest
yarn test:jest_integration