[Story] Make it easier to update the OC API docs image

Sage-Bionetworks / sage-monorepo

Where OpenChallenges, Schematic, and other Sage open source apps are built

https://sage-bionetworks.github.io/sage-monorepo/

Apache License 2.0

21 stars 12 forks source link

[Story] Make it easier to update the OC API docs image #2366

Closed tschaffter closed 9 months ago

tschaffter commented 9 months ago

What product(s) is this story for?

OpenChallenges

As a user, I want

As a Developer, I want the image of the OC API docs to be updated on GHCR so that the new image can be deployed.

Description

Currently, the API docs image is built with nx build-image openchallenges-api-docs. However, this project/tasks do not depend on the API description project, so the task will never be triggered as part of the CI workflow.

Acceptance criteria

No response

Tasks

No response

Anything else?

No response

Have you linked this story to a GitHub Project?

[X] I have linked this story to a GitHub Project and set its metadata.

tschaffter commented 9 months ago

Actually the project openchallenges-api-docs does have a dependency on openchallenges-api-docs:

"implicitDependencies": ["openchallenges-api-description"]

Q: Did the API docs image got rebuilt and published the last time the API docs has been updated?
A: Yes, the image has been updated yesterday, see the list of API Docs images

tschaffter commented 9 months ago

I confirm that the edge version of the API docs is correct and has been properly updated. I'm not sure why the docs didn't get update when building the stack locally.

tschaffter commented 9 months ago

I removed all the images, built the stack locally and the API docs appears up to date. I'm not sure what the issue was. The build files of the API docs were already up-to-date before I did anything.