Skip to content

Commit

Permalink
Doc fixes 1.17 (#10269)
Browse files Browse the repository at this point in the history
Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>
  • Loading branch information
Rachael-Graham and soloio-bulldozer[bot] authored Nov 8, 2024
1 parent 65ed09f commit 051b0ca
Show file tree
Hide file tree
Showing 103 changed files with 753 additions and 765 deletions.
35 changes: 34 additions & 1 deletion .github/workflows/push-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,37 @@ jobs:
--base main \
--head ${{ steps.create-branch.outputs.branch }} \
--reviewer solo-io/solo-docs
popd || exit 1
popd || exit 1
slack-notification:
runs-on: ubuntu-latest
needs:
- copy-docs
steps:
- name: Notify on workflow success
if: |
needs.copy-docs.result == 'success'
env:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
run: |
MESSAGE="✅ *Success:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
curl \
-d "text=$MESSAGE" \
-d "channel=doctopus-tests" \
-d "token=${SLACK_BOT_TOKEN}" \
-X POST https://slack.com/api/chat.postMessage
- name: Notify on workflow failure
if: |
needs.copy-docs.result == 'failure'
env:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
run: |
JOB_URL=https://github.com/solo-io/gloo/actions/runs/${GITHUB_RUN_ID}
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} failed. <${JOB_URL}|Review the workflow failure>"
curl \
-d "text=$MESSAGE" \
-d "channel=doctopus-tests" \
-d "token=${SLACK_BOT_TOKEN}" \
-X POST https://slack.com/api/chat.postMessage
5 changes: 5 additions & 0 deletions changelog/v1.17.16/doc-fixes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
changelog:
- type: NON_USER_FACING
description: >-
Weekly doc fixes, including API proto doc format changes and an update to the copy-docs workflow.
skipCI-kube-tests:true
12 changes: 6 additions & 6 deletions docs/content/reference/api/envoy/api/v2/route/route.proto.sk.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 051b0ca

Please sign in to comment.