Skip to content

Document local development and Keycloak setup#84

Merged
Subhransu-De merged 8 commits into
mainfrom
docs/local-development-guides
Jul 11, 2026
Merged

Document local development and Keycloak setup#84
Subhransu-De merged 8 commits into
mainfrom
docs/local-development-guides

Conversation

@Subhransu-De

Copy link
Copy Markdown
Owner

Summary

Validation

  • Markdownlint passes for all files under docs/
  • actionlint passes for the documentation workflow
  • the copy-ready environment example passes docker compose config
  • an isolated Compose stack verified the API, migrations, Keycloak realm, clients, and OIDC discovery

@Subhransu-De

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: 09e157ac3e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@Subhransu-De

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b26e9177f6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- ".sonarcloud.properties"
- ".github/dependabot.yml"
- ".github/workflows/**.yml"
- ".github/workflows/workflow.yml"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep actionlint on workflow-file PRs

When a PR changes .github/workflows/documentation.yml, this narrowed path filter prevents the CI/CD workflow's actionlint job from running; I checked the new documentation workflow and it only runs markdownlint, so syntax or GitHub Actions expression errors in that workflow can be merged without the repository's workflow lint gate that previously covered .github/workflows/**.yml.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Added a dedicated GitHub Actions lint workflow that runs whenever any workflow file changes.

@Subhransu-De

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b26e9177f6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- ".sonarcloud.properties"
- ".github/dependabot.yml"
- ".github/workflows/**.yml"
- ".github/workflows/workflow.yml"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep workflow edits under the Actions lint gate

When a PR changes only another workflow such as .github/workflows/documentation.yml, this narrowed path filter prevents the CI/CD workflow's existing actionlint job from starting; the new documentation workflow only runs markdownlint, so future edits to that workflow no longer get the repository's Actions lint check. Keep the broader workflow glob here, or add an actionlint job to the documentation workflow for workflow-file changes.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Added a dedicated GitHub Actions lint workflow that covers every workflow file change while keeping application CI scoped.

@Subhransu-De

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 314cb63293

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- ".sonarcloud.properties"
- ".github/dependabot.yml"
- ".github/workflows/**.yml"
- ".github/workflows/workflow.yml"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep CI gates on workflow-only changes

When a PR changes only one of the new workflow files, such as .github/workflows/documentation.yml or .github/workflows/actions-lint.yml, this path filter no longer starts the CI/CD workflow unless workflow.yml is also touched. The replacement actions-lint workflow only runs actionlint, so the existing Gitleaks and other validation gates in this workflow are skipped for workflow-only PRs; include all workflow files here or move those gates to a workflow that still watches them.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Added secret scanning to the dedicated workflow checks. Workflow-only changes now run both Gitleaks and actionlint without triggering unrelated application tests.

@Subhransu-De

Copy link
Copy Markdown
Owner Author

@codex review

@sonarqubecloud

Copy link
Copy Markdown

@Subhransu-De Subhransu-De merged commit 6f0b6dc into main Jul 11, 2026
21 checks passed
@Subhransu-De Subhransu-De deleted the docs/local-development-guides branch July 11, 2026 15:02
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. What shall we delve into next?

Reviewed commit: 6085fb7169

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

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.

1 participant