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

📝 services.md: autodocs openapi specs and images for each service #6779

Merged
merged 15 commits into from
Nov 21, 2024

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Nov 20, 2024

What do these changes do?

Auto generates services.md with relevant info about services.

make services.md

It would look like this ...

image

Related issue/s

How to test

Dev-ops

None

@pcrespov pcrespov self-assigned this Nov 20, 2024
@pcrespov pcrespov added this to the Event Horizon milestone Nov 20, 2024
@pcrespov pcrespov enabled auto-merge (squash) November 20, 2024 18:35
Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (5732a12) to head (f3788ad).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6779      +/-   ##
==========================================
- Coverage   88.49%   88.40%   -0.10%     
==========================================
  Files        1545      695     -850     
  Lines       62631    34660   -27971     
  Branches     2155      263    -1892     
==========================================
- Hits        55428    30641   -24787     
+ Misses       6876     3959    -2917     
+ Partials      327       60     -267     
Flag Coverage Δ
integrationtests 53.46% <ø> (-11.30%) ⬇️
unittests 87.76% <ø> (+0.65%) ⬆️
Components Coverage Δ
api ∅ <ø> (∅)
pkg_aws_library ∅ <ø> (∅)
pkg_dask_task_models_library ∅ <ø> (∅)
pkg_models_library ∅ <ø> (∅)
pkg_notifications_library ∅ <ø> (∅)
pkg_postgres_database ∅ <ø> (∅)
pkg_service_integration ∅ <ø> (∅)
pkg_service_library ∅ <ø> (∅)
pkg_settings_library ∅ <ø> (∅)
pkg_simcore_sdk 77.36% <ø> (-8.00%) ⬇️
agent 97.00% <ø> (ø)
api_server ∅ <ø> (∅)
autoscaling ∅ <ø> (∅)
catalog ∅ <ø> (∅)
clusters_keeper ∅ <ø> (∅)
dask_sidecar ∅ <ø> (∅)
datcore_adapter 93.17% <ø> (ø)
director ∅ <ø> (∅)
director_v2 91.42% <ø> (ø)
dynamic_scheduler ∅ <ø> (∅)
dynamic_sidecar 89.75% <ø> (ø)
efs_guardian ∅ <ø> (∅)
invitations ∅ <ø> (∅)
osparc_gateway_server 79.79% <ø> (-5.70%) ⬇️
payments ∅ <ø> (∅)
resource_usage_tracker ∅ <ø> (∅)
storage 89.66% <ø> (ø)
webclient ∅ <ø> (∅)
webserver 87.55% <ø> (-1.14%) ⬇️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5732a12...f3788ad. Read the comment docs.

---- 🚨 Try these New Features:

@pcrespov pcrespov added the a:doc documentation, reporting, admin tasks label Nov 20, 2024
Copy link
Member

@odeimaiz odeimaiz left a comment

Choose a reason for hiding this comment

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

💅

@pcrespov pcrespov disabled auto-merge November 20, 2024 19:13
@pcrespov pcrespov enabled auto-merge (squash) November 20, 2024 20:24
Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

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

pretty slick!

Copy link
Contributor

@matusdrobuliak66 matusdrobuliak66 left a comment

Choose a reason for hiding this comment

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

beautiful!

Copy link
Contributor

@bisgaard-itis bisgaard-itis left a comment

Choose a reason for hiding this comment

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

Super nice! A few suggestions/thoughts from my side.

scripts/echo_services_markdown.py Outdated Show resolved Hide resolved
scripts/echo_services_markdown.py Outdated Show resolved Hide resolved
scripts/echo_services_markdown.py Show resolved Hide resolved
services.md Outdated Show resolved Hide resolved
Copy link
Contributor

@giancarloromeo giancarloromeo left a comment

Choose a reason for hiding this comment

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

👌

@pcrespov pcrespov disabled auto-merge November 21, 2024 10:06
@pcrespov pcrespov merged commit 2504277 into ITISFoundation:master Nov 21, 2024
84 of 88 checks passed
@pcrespov pcrespov deleted the is23/readmes-services branch November 21, 2024 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:doc documentation, reporting, admin tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update toc with badges to docker-hub repo for each service
7 participants