docs(ci): adds generated reference workflow #197
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Generate Slack CLI Docs | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| update-docs: | ||
|
Member
There was a problem hiding this comment. 🔐 todo: This'll also need some set of permissions. Do let me know if I can help with this! |
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
|
|
||
| - name: Install Slack CLI | ||
| run: | | ||
| curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash | ||
|
|
||
| - name: Generate a GitHub token | ||
| id: ghtoken | ||
| uses: actions/create-github-app-token@v2 | ||
|
Member
There was a problem hiding this comment. 💔 todo: We should use pinned versions here though I don't think the healthscore has released such a check yet... 📫 note: I can soon add these versions if needed! |
||
| with: | ||
| app-id: ${{ secrets.GH_APP_ID }} | ||
| owner: slackapi | ||
| private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Generate docs | ||
| run: | | ||
| slack docgen docs/reference | ||
|
|
||
| - name: Create a pull request | ||
| uses: peter-evans/create-pull-request@v7 | ||
| with: | ||
| token: ${{ steps.ghtoken.outputs.token }} | ||
| title: "Automated Slack CLI reference docs for release" | ||
| body: "Automatically updating Slack CLI docs following release" | ||
| author: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>" | ||
| committer: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>" | ||
| commit-message: "Update slack cli reference docs" | ||
| base: "main" | ||
| branch: "update-slack-cli-reference" | ||
| delete-branch: true | ||
| labels: docs | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👁️🗨️ thought: Adding on "version" tags might be interesting! Otherwise we will need to add this to our release runbooks.
📣 ramble: So open to saving this for follow ups of course.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🗣️ note: Ugh that was more clear in mind... I meant to suggest "on new tagged releases the workflow should run" but I forget the syntax!