Skip to content

chore: remove the docs sync app secrets from the maintainers guide #756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zimeg merged 1 commit into from
Nov 6, 2026
Merged

chore: remove the docs sync app secrets from the maintainers guide #756

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/MAINTAINERS_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,6 @@ Certain things are common during development and require a few commands.
- [Running](#running)
- [Setting a global alias](#setting-a-global-alias)
- [Generating documentation](#generating-documentation)
- [Synchronizing changes upstream](#synchronizing-changes-upstream)
- [Versioning](#versioning)
- [Updating](#updating)
- [Bumping the Golang version](#bumping-the-golang-version)
Expand Down Expand Up @@ -453,26 +452,6 @@ You can generate documentation for all commands in the `docs/` directory with:
slack docgen
```

#### Synchronizing changes upstream

Automated workflows run on documentation changes to [sync][sync] files between
this project and the documentation build.

A GitHub application called [`@slackapi[bot]`][github-app-docs] mirrors changes
to these files and requires certain permissions:

- **Actions**: Read and write
- **Contents**: Read and write
- **Metadata**: Read
- **Pull requests**: Read and write

Access to both this project repo and documentation repo must also be granted.

Credentials and secrets for the app can be stored as the following variables:

- `GH_APP_ID_DOCS`
- `GH_APP_PRIVATE_KEY_DOCS`

### Versioning

We use git tags and [semantic versioning][semver] to version this program. The
Expand Down Expand Up @@ -847,7 +826,6 @@ When in doubt, find the other maintainers and ask.
[contributing]: ./CONTRIBUTING.md
[dev-release]: https://github.com/slackapi/slack-cli/releases/tag/dev-build
[effective-go]: https://golang.org/doc/effective_go
[github-app-docs]: https://github.com/apps/slackapi
[github-app-releaser]: https://github.com/apps/slack-cli-releaser
[goinstaller]: https://go.dev/doc/install
[golang]: https://golang.org/
Expand All @@ -865,7 +843,6 @@ When in doubt, find the other maintainers and ask.
[scripts]: ../scripts
[semver]: https://semver.org/
[style-guide]: ./STYLE_GUIDE.md
[sync]: https://github.com/slackapi/slack-cli/blob/main/.github/workflows/sync-docs-from-cli-repo.yml
[vscode]: https://github.com/slackapi/slack-cli/blob/main/.vscode/settings.json
[wf-dependencies]: ./workflows/dependencies.yml
[wf-milestone]: ./workflows/milestone.yml
Loading