-
Notifications
You must be signed in to change notification settings - Fork 15
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
Local development improvements #2085
Conversation
cofiem
commented
Apr 15, 2024
- use more recent codecov cli
- compile typescript with source maps for code coverage
- produce junit test output to show test results in circleci
- add easier local dev setup
- skip doiservice tests when auth details are missing
Use updated codecov in ci.
Include source maps in test coverage.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #2085 +/- ##
============================================
- Coverage 70.14% 49.37% -20.78%
============================================
Files 112 163 +51
Lines 1876 7996 +6120
Branches 218 1132 +914
============================================
+ Hits 1316 3948 +2632
- Misses 560 3652 +3092
- Partials 0 396 +396
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good to me. With the api descriptors script, I'm not against keeping it but the api documentation process is as follows:
- The source descriptor document is an API Blueprint document. It's stored as an ejs file https://github.com/redbox-mint/redbox-portal/blob/master/views/default/default/apidocsapib.ejs so that you can visit it at //<portal/api-docs.apib on any instance and it'll show the correct urls
- OpenAPI yaml and json descriptors are generated from this document. In the source code these ejs templates are just placeholders but are generated at build time and bundled e.g. https://github.com/redbox-mint/redbox-portal/blob/master/views/default/default/apidocsswaggeryaml.ejs
- The apib document is used to generate the HTML documentation available at https://redbox-mint.github.io/redbox-portal/additional-documentation/rest-api.html
Because of 2, if we are to keep running this script as part of "prepareLocalDev" we'll need to at least put the 2 openAPI ejs templates into the gitignore so we don't accidentally commit the generated versions.