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

chore: Add mermaid documentation #131

Merged
merged 2 commits into from
Nov 5, 2024
Merged

chore: Add mermaid documentation #131

merged 2 commits into from
Nov 5, 2024

Conversation

mikelax
Copy link
Collaborator

@mikelax mikelax commented Nov 5, 2024

Overview

  • Replace entity relationship diagram image with mermaid documentation
  • Clean up GitHub action tests workflow to remove unused environment variables
  • BUGFIX: Update logic in the-usher.js that checks SKIP_KEYS_CHECK env variable. Values coming from process.env are always either strings or undefined. Previous logic only checked if env variable existed (could be set to any value).

Your PR Checklist 🚨

❤️ Please review the guidelines for contributing to this repository. Our goal is to merge PRs fast 💨 .

  • Check your code additions will fail neither code linting checks nor unit tests.
  • Additional units tests have been added to prove code updates work and fixes are effective
  • Additional documentation has been added (if appropriate)
  • Update Assignee field to yourself

Issue Reference

Closes #

Open Questions or Items to Callout

@mikelax mikelax added the documentation Improvements or additions to documentation label Nov 5, 2024
@mikelax mikelax self-assigned this Nov 5, 2024
@mikelax mikelax requested a review from k1ch November 5, 2024 13:45
@mikelax
Copy link
Collaborator Author

mikelax commented Nov 5, 2024

@k1ch please check out the bugfix for the SKIP_KEYS_CHECK env variable.

@mikelax mikelax added the bug Something isn't working label Nov 5, 2024
@mikelax mikelax merged commit f77fd98 into main Nov 5, 2024
4 checks passed
@mikelax mikelax deleted the topics/mermaid-erdiagram branch November 5, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants