Skip to content

feat: update .env.example#75

Merged
kasin-it merged 1 commit into
mainfrom
dev
May 8, 2026
Merged

feat: update .env.example#75
kasin-it merged 1 commit into
mainfrom
dev

Conversation

@kasin-it
Copy link
Copy Markdown
Collaborator

@kasin-it kasin-it commented May 8, 2026

Summary by CodeRabbit

  • Documentation

    • Reorganized setup guide with expanded security configuration instructions and clearer integration guidance.
    • Moved detailed installation and deployment steps to dedicated documentation.
  • New Features

    • Added optional Review Phase feature (disabled by default) for self-review workflow step before push.

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ai-workflow-app Building Building May 8, 2026 1:44pm
ai-workflow-app (ai-workflow-demo) Ready Ready Preview, Comment May 8, 2026 1:44pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1abe80ed-1386-4db4-95b6-b6938981a7a2

📥 Commits

Reviewing files that changed from the base of the PR and between 068a577 and 063a1ee.

📒 Files selected for processing (3)
  • .env.example
  • README.md
  • SETUP.md

📝 Walkthrough

Walkthrough

The PR consolidates setup documentation into a dedicated SETUP.md file while adding environment variables for Phase 3 (Review) capability and Slack integration. External account provisioning is updated to use secure service accounts, GitHub Apps (replacing legacy PAT tokens), and narrower Slack bot scopes. README.md is condensed to reference SETUP.md.

Changes

Documentation & Configuration Consolidation

Layer / File(s) Summary
Environment Configuration
.env.example
New environment variables for Phase 3 Review toggle (ENABLE_REVIEW_PHASE), Slack slash-command secrets (SLACK_SIGNING_SECRET, SLACK_ALLOWED_USER_IDS), and expanded messaging configuration guidance.
Documentation Structure
README.md, SETUP.md
README condensed to brief "Setup" section pointing to SETUP.md; SETUP.md restructured with renumbered steps (Deploy becomes step 6); "Local development (optional)" section removed.
External Account Provisioning
SETUP.md
Jira setup now uses scoped service accounts with granular token scopes; GitHub section requires GitHub App (with exact permissions/scope) instead of legacy PAT, and explicitly removes GITHUB_TOKEN path; Slack uses narrower bot scopes (chat:write, commands) with channel invite requirements.
Integration Variables & Registration
SETUP.md
Required variables table updated to include GitHub App fields instead of GITHUB_TOKEN; Jira webhook (step 7), Slack slash command (step 8), smoke test (step 9), CI (step 10), optional integrations (step 11), and troubleshooting (step 12) all renumbered; GitHub App permission/installation diagnostics added to troubleshooting.
Workflow Documentation
README.md
Phase 3 (Review) documented as implemented but gated behind ENABLE_REVIEW_PHASE (default false), executing after Phase 2 with self-review/fix behavior before push.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • Blazity/mdcms#54: README documentation updates affecting user-facing guidance and setup instructions.

Poem

🐰 Hops through docs with glee,
Phase 3 review now set to see,
Apps and tokens, scopes so tight,
Setup guide shines crystal bright!
Security hops, documentation leaps—
This PR's magic runs real deep!


Comment @coderabbitai help to get the list of available commands and usage tips.

@kasin-it kasin-it merged commit 169fe67 into main May 8, 2026
3 of 4 checks passed
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