Skip to content

docs: set up the Slack integration from a prefilled Codacy app [OD-533] - #2820

Open
claudiacodacy wants to merge 1 commit into
masterfrom
od-533-slack-app-manifest
Open

claudiacodacy wants to merge 1 commit into
masterfrom
od-533-slack-app-manifest

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Updates Organization Slack integration for OD-533. The old link to Slack's Incoming WebHooks App Directory page no longer works for users (support case in the issue).

  • On Slack: the steps now start from a link that opens Slack's Create from a manifest with a Codacy app prefilled (name, description, background colour, bot user, incoming-webhook scope). The user picks a workspace and a channel, then copies the webhook URL from Incoming Webhooks. Labels checked against Slack on 2026-11-09 by running the flow end to end in a test workspace (test app deleted afterwards).
  • App icon: a manifest can't set one, so there's an optional step with a new 1000×1000 images/codacy-slack-app-icon.png, cropped from docs/assets/images/codacy-logo.png (1000×1001; Slack wants a square image). The Codacy app will link to this file.
  • On Codacy: "Incoming WebHook URL" becomes "webhook URL", matching what Slack calls it now.

No headings changed, so anchors are unchanged. No lockstep note or shared include on this page. The Self-hosted page (chart/using-codacy/slack-integration.md) documents the repository-level integration and is left as is.

The slack-integration-install.png screenshot still shows the old Codacy steps. It should be replaced once the matching codacy-spa change ships.

Checks

  • mkdocs build --strict: passes.
  • vale docs/organizations/integrations/slack-integration.md: 0 errors, 0 warnings, 0 suggestions.

🤖 Generated with Claude Code

The Incoming WebHooks App Directory link no longer works for users. The
steps now open Slack's "Create from a manifest" with a Codacy app
prefilled, then take the webhook URL from the app's Incoming Webhooks.
Adds a 1000x1000 Codacy logo users can upload as the app icon.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@claudiacodacy
claudiacodacy requested a review from a team as a code owner November 9, 2026 14:25
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 54.54 (🟢 +0.04)

File Readability
slack-integration.md 60.52 (🟢 +11.59)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
slack-integration.md 60.52 40.14 9.1 11.3 12.69 7.12
  🟢 +11.59 🟢 +10.28 🟢 +1.55 🟢 +2.4 🟢 +2.27 🟢 +0.17

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.54 43 10.8 12.28 12.31 7.95
  🟢 +0.04 🟢 +0.03 🟢 +0.01 🟢 +0.01 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

✅ No blocking issues noticed

No blocking findings were identified. The intent criteria appear addressed by the submitted documentation, but the rendered links and prefilled manifest settings still lack automated validation.

Test suggestions

  • Validate that the rendered documentation contains the complete Slack manifest setup flow and valid linked assets.
  • Validate that the prefilled Slack manifest link opens with the documented Codacy app settings and incoming-webhook scope.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Validate that the rendered documentation contains the complete Slack manifest setup flow and valid linked assets.
2. Validate that the prefilled Slack manifest link opens with the documented Codacy app settings and incoming-webhook scope.

TIP How was this review? Give us feedback

@github-actions
github-actions Bot temporarily deployed to Netlify November 9, 2026 14:26 Inactive

This branch was previously deployed

1 inactive deployment
Netlify — 4f99e6b4 Deployed Nov 9, 2026 by github-actions[bot]
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