Skip to content

Commit bbd6d8b

Browse files
committed
@sanderegg review: skip hidden files
1 parent 14fbcec commit bbd6d8b

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,8 @@ auto-doc: .stack-simcore-version.yml ## Auto generates diagrams for README.md
624624
# Updating docs/img
625625
@mv --verbose $<.png docs/img/
626626

627-
.PHONY: services.ignore.md
628-
services.ignore.md: ## Auto generates service.md
627+
.PHONY: SERVICES.md
628+
SERVICES.md: ## Auto generates service.md
629629
# Making $@
630630
scripts/echo_services_markdown.py > $@
631631

SERVICES.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# services
22
>
3-
> Auto generated on `2025-05-23 14:45:20` using
3+
> Auto generated on `2025-05-26 09:50:15` using
44
```cmd
55
cd osparc-simcore
66
python ./scripts/echo_services_markdown.py
@@ -11,17 +11,11 @@ python ./scripts/echo_services_markdown.py
1111
| |[services/agent/Dockerfile](./services/agent/Dockerfile)|[![Docker Image Size](https://img.shields.io/docker/image-size/itisfoundation/agent)](https://hub.docker.com/r/itisfoundation/agent/tags) |
1212
| **API-SERVER**|| |
1313
| |[services/api-server/openapi.json](./services/api-server/openapi.json)|[![ReDoc](https://img.shields.io/badge/OpenAPI-ReDoc-85ea2d?logo=openapiinitiative)](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/api-server/openapi.json) [![Swagger UI](https://img.shields.io/badge/OpenAPI-Swagger_UI-85ea2d?logo=swagger)](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/api-server/openapi.json) |
14-
| |[services/api-server/.mypy_cache/3.11/servicelib/fastapi/openapi.data.json](./services/api-server/.mypy_cache/3.11/servicelib/fastapi/openapi.data.json)| |
15-
| |[services/api-server/.mypy_cache/3.11/servicelib/fastapi/openapi.meta.json](./services/api-server/.mypy_cache/3.11/servicelib/fastapi/openapi.meta.json)| |
16-
| |[services/api-server/.mypy_cache/3.11/simcore_service_api_server/core/openapi.data.json](./services/api-server/.mypy_cache/3.11/simcore_service_api_server/core/openapi.data.json)| |
17-
| |[services/api-server/.mypy_cache/3.11/simcore_service_api_server/core/openapi.meta.json](./services/api-server/.mypy_cache/3.11/simcore_service_api_server/core/openapi.meta.json)| |
1814
| |[services/api-server/Dockerfile](./services/api-server/Dockerfile)|[![Docker Image Size](https://img.shields.io/docker/image-size/itisfoundation/api-server)](https://hub.docker.com/r/itisfoundation/api-server/tags) |
1915
| **AUTOSCALING**|| |
2016
| |[services/autoscaling/Dockerfile](./services/autoscaling/Dockerfile)|[![Docker Image Size](https://img.shields.io/docker/image-size/itisfoundation/autoscaling)](https://hub.docker.com/r/itisfoundation/autoscaling/tags) |
2117
| **CATALOG**|| |
2218
| |[services/catalog/openapi.json](./services/catalog/openapi.json)|[![ReDoc](https://img.shields.io/badge/OpenAPI-ReDoc-85ea2d?logo=openapiinitiative)](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/catalog/openapi.json) [![Swagger UI](https://img.shields.io/badge/OpenAPI-Swagger_UI-85ea2d?logo=swagger)](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/catalog/openapi.json) |
23-
| |[services/catalog/.mypy_cache/3.11/servicelib/fastapi/openapi.data.json](./services/catalog/.mypy_cache/3.11/servicelib/fastapi/openapi.data.json)| |
24-
| |[services/catalog/.mypy_cache/3.11/servicelib/fastapi/openapi.meta.json](./services/catalog/.mypy_cache/3.11/servicelib/fastapi/openapi.meta.json)| |
2519
| |[services/catalog/Dockerfile](./services/catalog/Dockerfile)|[![Docker Image Size](https://img.shields.io/docker/image-size/itisfoundation/catalog)](https://hub.docker.com/r/itisfoundation/catalog/tags) |
2620
| **CLUSTERS-KEEPER**|| |
2721
| |[services/clusters-keeper/Dockerfile](./services/clusters-keeper/Dockerfile)|[![Docker Image Size](https://img.shields.io/docker/image-size/itisfoundation/clusters-keeper)](https://hub.docker.com/r/itisfoundation/clusters-keeper/tags) |

scripts/echo_services_markdown.py

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#!/bin/env python
2-
""" Usage
2+
"""Usage
33
4-
cd osparc-simcore
5-
./scripts/echo_services_markdown.py >services.md
4+
cd osparc-simcore
5+
./scripts/echo_services_markdown.py >services.md
66
"""
77

88
import itertools
@@ -16,9 +16,9 @@
1616
CURRENT_FILE = Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve()
1717
CURRENT_DIR = CURRENT_FILE.parent
1818

19-
_URL_PREFIX: Final[
20-
str
21-
] = "https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master"
19+
_URL_PREFIX: Final[str] = (
20+
"https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master"
21+
)
2222

2323
_REDOC_URL_PREFIX: Final[str] = f"https://redocly.github.io/redoc/?url={_URL_PREFIX}"
2424
_SWAGGER_URL_PREFIX: Final[str] = f"https://petstore.swagger.io/?url={_URL_PREFIX}"
@@ -110,12 +110,19 @@ def _to_tuple(file: Path):
110110
file.relative_to(repo_base_path),
111111
)
112112

113-
dockerfiles_found = (_to_tuple(file) for file in services_path.rglob("Dockerfile"))
113+
def _is_hidden(file: Path) -> bool:
114+
return any(p.name.startswith(".") for p in file.parents)
115+
116+
dockerfiles_found = (
117+
_to_tuple(file)
118+
for file in services_path.rglob("Dockerfile")
119+
if not _is_hidden(file)
120+
)
114121

115122
openapi_files_found = (
116123
_to_tuple(file)
117124
for file in services_path.rglob("openapi.*")
118-
if file.suffix in {".json", ".yaml", ".yml"}
125+
if file.suffix in {".json", ".yaml", ".yml"} and not _is_hidden(file)
119126
)
120127

121128
markdown_table = generate_markdown_table(

0 commit comments

Comments
 (0)