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

Local development improvements #2085

Merged
merged 10 commits into from
Apr 16, 2024
Merged

Conversation

cofiem
Copy link
Contributor

@cofiem 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

Copy link

codecov bot commented Apr 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.37%. Comparing base (205d7bd) to head (b945075).
Report is 3 commits behind head on develop.

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     
Flag Coverage Δ
backend-mocha 44.93% <ø> (?)
backend-newman 42.33% <ø> (?)
frontend-core-lib 52.41% <ø> (ø)
frontend-dashboard 88.07% <ø> (ø)
frontend-export 100.00% <ø> (ø)
frontend-local-auth 100.00% <ø> (ø)
frontend-manage-roles 63.33% <ø> (ø)
frontend-manage-users 59.81% <ø> (ø)
frontend-report 100.00% <ø> (ø)

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.

@cofiem cofiem self-assigned this Apr 15, 2024
@cofiem cofiem marked this pull request as ready for review April 15, 2024 04:35
@cofiem cofiem requested a review from andrewbrazzatti April 15, 2024 04:35
Copy link
Contributor

@andrewbrazzatti andrewbrazzatti left a 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:

  1. 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
  2. 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
  3. 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.

support/development/prepareLocalDev.sh Outdated Show resolved Hide resolved
@andrewbrazzatti andrewbrazzatti merged commit 1f1f07b into develop Apr 16, 2024
6 of 7 checks passed
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.

2 participants