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

Add 'Create ERD' step to CI/CD pipeline #330

Open
dpgraham4401 opened this issue Feb 13, 2023 · 2 comments
Open

Add 'Create ERD' step to CI/CD pipeline #330

dpgraham4401 opened this issue Feb 13, 2023 · 2 comments
Labels
CI/CD Requires modiciations to the continuous integration pipeline(s) database changes that require modification to the database schema documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@dpgraham4401
Copy link
Member

dpgraham4401 commented Feb 13, 2023

🚀 Feature Request

PR should include github action that builds the Entity Relationship Diagram (ERD) in our documentation.

Specs

  1. it should only run when there are new migration scripts
    • we have other workflows that do this, see examples for path filters.
  2. It will need to install the graphviz header files
    • apt-get install graphviz graphviz-dev
  3. It will need to install pygraphviz which can be done
    • pip install pygraphviz
  4. It can execute the creation of the new image with the runhaz.sh script like so
    • ./runhaz.sh -e
  5. It then needs to commit that newly generated ERD and push it to GitHub
    • which branch and what part of the CI/CD pipeline does this run on.
    • If possible, we would prefer this run in the context of the PR, commits back to the PR branch which then gets squashed on merge by the maintainers.
    • This needs to run before the docs are deployed to GH pages.

For now I may just keep generating locally.

@dpgraham4401 dpgraham4401 added documentation Improvements or additions to documentation good first issue Good for newcomers database changes that require modification to the database schema CI/CD Requires modiciations to the continuous integration pipeline(s) labels Feb 13, 2023
@dpgraham4401 dpgraham4401 added this to the Backlog milestone Feb 28, 2023
@dpgraham4401
Copy link
Member Author

dpgraham4401 commented Mar 9, 2023

see community discussion on adding commits to a PR from github actions here https://github.com/orgs/community/discussions/24945#discussioncomment-3245946

@dpgraham4401
Copy link
Member Author

see our documentation on generating the ERD here https://usepa.github.io/haztrak/design/db-design.html#notes-on-generating-the-erd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Requires modiciations to the continuous integration pipeline(s) database changes that require modification to the database schema documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
No open projects
Status: 🆕 ToDo
Development

No branches or pull requests

1 participant