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

[OE] Adds dev doc script to precommit hook #6585

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ashwin-pc
Copy link
Member

@ashwin-pc ashwin-pc commented Apr 22, 2024

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

  • Add a new Markdown file to the docs folder
  • Try to commit that chnage without running yarn docs:generateDevDocs
  • The commit should fail with the updated sidebar in the unstaged section
  • Staging it should resolve the issue and allow you to commit the change

Changelog

  • chore: Adds a git pre commit hook to ensure that developer docs are always updated

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
SuZhou-Joe
SuZhou-Joe previously approved these changes Apr 23, 2024
Signed-off-by: Ashwin P Chandran <ashwinpc1993@gmail.com>
Copy link

codecov bot commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.70%. Comparing base (9ac5203) to head (6a77fc1).

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     
Flag Coverage Δ
Linux_1 33.18% <ø> (ø)
Linux_2 55.59% <ø> (ø)
Linux_3 45.24% <ø> (-0.02%) ⬇️
Linux_4 34.84% <ø> (ø)
Windows_1 33.20% <ø> (ø)
Windows_2 55.56% <ø> (ø)
Windows_3 45.26% <ø> (ø)
Windows_4 34.84% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Co-authored-by: Miki <amoo_miki@yahoo.com>
Signed-off-by: Ashwin P Chandran <ashwinpc1993@gmail.com>
SuZhou-Joe
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants