slackapi / slackapi/slack-github-action

docs: improve app creation for incoming webhook technique

Open Beginner friendly
#667 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
1.3k
Forks
200
Avg merge
2h 59m
Merged PRs (30d)
6

Description

📚 The setup steps of the incoming webhook technique require multiple steps on an adjacent UI. We might suggest creating an app with the following manifest:

🔗 https://docs.slack.dev/tools/slack-github-action/sending-data-slack-incoming-webhook#setup

{
  "_metadata": {
    "major_version": 1
  },
  "display_information": {
    "name": "GitHub Actions",
    "description": "Incoming webhook for GitHub Actions notifications"
  },
  "features": {
    "bot_user": {
      "display_name": "GitHub Actions"
    }
  },
  "oauth_config": {
    "scopes": {
      "bot": ["incoming-webhook"]
    }
  },
  "settings": {
    "org_deploy_enabled": true,
    "incoming_webhooks": {
      "incoming_webhooks_enabled": true
    }
  }
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked incoming webhook setup section and compare its current app-creation steps with the proposed manifest. Update the documentation to suggest creating the app from that manifest, then verify the setup instructions and rendered documentation are clear and complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.