diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 56ea685..24669b8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -58,7 +58,8 @@ The standard workflow for contributing is as follows: 5. Create a Pull Request (PR) against the repository's `dev` branch (not `main`). 6. Wait for review and feedback from the maintainers, address any comments or suggestions. 7. Once approved, your changes will be merged into the `dev` branch and deployed to staging for testing. -8. After successful testing in staging, changes are promoted from `dev` to `main` for production deployment. +8. After all pre-commit checks pass, deployment to staging is triggered automatically. +9. Production deployment is performed manually by authorized maintainers after successful staging validation. > [!WARNING] > Please note that you will not be able to push directly to either the `dev` or `main` branches of the repository. All @@ -222,9 +223,10 @@ Use [Conventional Commits](https://www.conventionalcommits.org/) to keep commit * Link any related issues using `Closes #issue-number` * Add screenshots, terminal output, or examples if relevant +After your PR is merged into `dev`, all `pre-commit` checks will run automatically. If they pass, deployment to staging is triggered. The maintainers will review your PR, provide feedback, and may request changes. Once approved, your PR will be merged into the `dev` branch and deployed to staging for testing. After successful validation, changes will be promoted to -production. +production which is manually trigerred by authorized maintainers. ## ❓ Need Help? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 681ed0d..b4c6662 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,8 +14,8 @@ Please provide a concise summary of the changes: > ℹ️ **Fixes / Related Issues** -> Fixes: #123 -> Related: #456 +> Fixes: #100 +> Related: #001 ## 🧱 Type of Change @@ -68,7 +68,7 @@ Please provide a concise summary of the changes: - [ ] Changes are backwards compatible (if applicable) - [ ] Feature flags or `.env` vars updated (if applicable) - [ ] I've tested across multiple environments (if applicable) -- [ ] Benchmarks still meet expected performance (`scripts/benchmark_auth.py`) +- [ ] Benchmarks still meet expected performance (`scripts/benchmark/benchmark_requests.py`) ## 🛠️ Affected API Behaviour diff --git a/README.md b/README.md index d40a899..75025e9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Docker Image Build](https://github.com/pesu-dev/auth/actions/workflows/docker.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/docker.yml) [![Pre-Commit Checks](https://github.com/pesu-dev/auth/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/pre-commit.yaml) [![Lint](https://github.com/pesu-dev/auth/actions/workflows/lint.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/lint.yaml) -[![Deploy](https://github.com/pesu-dev/auth/actions/workflows/deploy.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/deploy.yaml) +[![Deploy](https://github.com/pesu-dev/auth/actions/workflows/deploy-prod.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/deploy-prod.yaml) [![Docker Automated build](https://img.shields.io/docker/automated/aditeyabaral/pesu-auth?logo=docker)](https://hub.docker.com/r/aditeyabaral/pesu-auth/builds) [![Docker Image Version (tag)](https://img.shields.io/docker/v/aditeyabaral/pesu-auth/latest?logo=docker&label=build%20commit)](https://hub.docker.com/r/aditeyabaral/pesu-auth/tags)