docs: add missing CI/CD workflow entries to deployment documentation - #625
Open
VerifiedFlemzy1 wants to merge 1 commit into
Open
docs: add missing CI/CD workflow entries to deployment documentation#625VerifiedFlemzy1 wants to merge 1 commit into
VerifiedFlemzy1 wants to merge 1 commit into
Conversation
|
@VerifiedFlemzy1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #477
This PR updates the deployment documentation to accurately reflect all CI/CD workflows in the repository.
What was fixed
The CI/CD pipeline table in
docs/DEPLOYMENT.mdoriginally listed only three workflows (ci.yml,release.yml,deploy.yml). The repository actually contains five active workflow files:load-test.yml– scheduled k6 load‑testing scenarios (and can be triggered manually)security-audit.yml– scheduled security audits (dependency audit, code scan, secret detection, license compliance) and can also be run manuallyChanges
load-test.ymlandsecurity-audit.ymlto the CI/CD pipeline table, including their triggers and a concise description of what each workflow does.No other files were modified.
Why this matters
Keeping the documentation in sync with the actual CI configuration prevents confusion for contributors and ensures that the CI/CD pipeline overview is complete and reliable.
Verification
The updated table now renders correctly in the Markdown preview and matches the files present in
.github/workflows/.Open the PR:
You can view and merge the PR using the following URL (GitHub will auto‑populate the PR with the pushed branch):
https://github.com/VerifiedFlemzy1/backend/pull/new/fix-deployment-ci-doc
If the URL opens the “Create Pull Request” screen, simply review the changes and click Create pull request.