Skip to content

Commit 051b0ca

Browse files
Doc fixes 1.17 (#10269)
Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>
1 parent 65ed09f commit 051b0ca

File tree

103 files changed

+753
-765
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+753
-765
lines changed

.github/workflows/push-docs.yaml

+34-1
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,37 @@ jobs:
158158
--base main \
159159
--head ${{ steps.create-branch.outputs.branch }} \
160160
--reviewer solo-io/solo-docs
161-
popd || exit 1
161+
popd || exit 1
162+
163+
slack-notification:
164+
runs-on: ubuntu-latest
165+
needs:
166+
- copy-docs
167+
steps:
168+
- name: Notify on workflow success
169+
if: |
170+
needs.copy-docs.result == 'success'
171+
env:
172+
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
173+
run: |
174+
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>"
175+
176+
curl \
177+
-d "text=$MESSAGE" \
178+
-d "channel=doctopus-tests" \
179+
-d "token=${SLACK_BOT_TOKEN}" \
180+
-X POST https://slack.com/api/chat.postMessage
181+
- name: Notify on workflow failure
182+
if: |
183+
needs.copy-docs.result == 'failure'
184+
env:
185+
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
186+
run: |
187+
JOB_URL=https://github.com/solo-io/gloo/actions/runs/${GITHUB_RUN_ID}
188+
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} failed. <${JOB_URL}|Review the workflow failure>"
189+
190+
curl \
191+
-d "text=$MESSAGE" \
192+
-d "channel=doctopus-tests" \
193+
-d "token=${SLACK_BOT_TOKEN}" \
194+
-X POST https://slack.com/api/chat.postMessage

changelog/v1.17.16/doc-fixes.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
changelog:
2+
- type: NON_USER_FACING
3+
description: >-
4+
Weekly doc fixes, including API proto doc format changes and an update to the copy-docs workflow.
5+
skipCI-kube-tests:true

docs/content/reference/api/envoy/api/v2/route/route.proto.sk.md

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)