Skip to content

Conversation

@vrajmohan
Copy link
Contributor

No description provided.

@vrajmohan vrajmohan force-pushed the vm-reinstate-erd branch 2 times, most recently from 4189493 to be7e22b Compare December 12, 2024 14:54
- if: $CI_COMMIT_BRANCH == "main"

publish_er_diagram:
stage: .post
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
stage: .post
stage: .post
needs:
- job: install
cache:
- <<: *ruby_cache

@vrajmohan vrajmohan force-pushed the vm-reinstate-erd branch 4 times, most recently from 1679485 to 587668a Compare December 12, 2024 18:48
changelog: Internal, Documentation, Generate the ER diagram on migrations

1. Diagrams are generated automatically during CI
2. Diagram can be customized using .erdconfig

We used to do this in the past and abandoned it in commit 47020c9,
as it was not maintained. This iteration should make it easier.
@vrajmohan
Copy link
Contributor Author

I was assuming that the artifacts from the publish_er_diagram job for the last successful main pipeline would be available at a well-known URL, something like https://docs.gitlab.com/ee/ci/jobs/job_artifacts.html#from-a-url. I now realize that this may not work and there is no prior art in our environment for publishing build artifacts to a standard location like an S3 bucket.

Would it be better for me to copy the way we generate the events for the analytics handbook - create a make task in the internal-handbook repo that would clone the identity-idp repo and run bundle exec rails erd?

@aduth
Copy link
Contributor

aduth commented Dec 13, 2024

I was assuming that the artifacts from the publish_er_diagram job for the last successful main pipeline would be available at a well-known URL, something like https://docs.gitlab.com/ee/ci/jobs/job_artifacts.html#from-a-url. I now realize that this may not work and there is no prior art in our environment for publishing build artifacts to a standard location like an S3 bucket.

What issues are you expecting won't allow it to work? I'd have imagined with a Pages configuration we could have a URL like https://lg.pages.production.gitlab.login.gov/identity-idp/idp_erd.svg to serve the latest artifact from main, although it would be access-restricted. Are you finding that that won't work?

I think doing it in a similar way to how analytics events could work too, if that ends up being a simpler path.

@vrajmohan
Copy link
Contributor Author

I am trying to leverage the build artifacts and avoid issuing commits for redundant information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants