Skip to content

Commit 2f59d4d

Browse files
[1.18 backport] Docs: workflow adjustment, version bumps (#10532)
Co-authored-by: Art Berger <[email protected]>
1 parent 0525c82 commit 2f59d4d

File tree

11 files changed

+39
-22
lines changed

11 files changed

+39
-22
lines changed

.github/workflows/push-docs.yaml

+23-13
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525
2626
copy-docs:
2727
runs-on: ubuntu-latest
28+
if: ${{ always() }}
29+
needs: receiver
2830
outputs:
2931
minor: ${{ steps.version-variables.outputs.minor }}
3032
steps:
@@ -35,7 +37,7 @@ jobs:
3537
if [[ "${{ github.event_name }}" == "release" ]]; then
3638
version=${{ github.event.release.target_commitish }}
3739
elif [[ "${{ github.event_name }}" == "repository_dispatch" ]]; then
38-
version=${{ steps.dispatch-receiver.outputs.dispatch_lts }}
40+
version=${{ needs.receiver.outputs.dispatch_lts }}
3941
else
4042
version=${{ inputs.branch }}
4143
fi
@@ -110,19 +112,19 @@ jobs:
110112
run: |
111113
pushd docs || exit 1
112114
# OSS
113-
cp ../gloo/docs/content/static/content/gloo-security-scan.docgen static/content/gg-security-updates/gloo-security-scan.docgen
114-
cp ../gloo/docs/content/static/content/gloo-security-scan-0.docgen static/content/gg-security-updates/gloo-security-scan-0.docgen
115-
cp ../gloo/docs/content/static/content/gloo-security-scan-1.docgen static/content/gg-security-updates/gloo-security-scan-1.docgen
116-
cp ../gloo/docs/content/static/content/gloo-security-scan-2.docgen static/content/gg-security-updates/gloo-security-scan-2.docgen
117-
cp ../gloo/docs/content/static/content/gloo-security-scan-3.docgen static/content/gg-security-updates/gloo-security-scan-3.docgen
118-
cp ../gloo/docs/content/static/content/gloo-security-scan-4.docgen static/content/gg-security-updates/gloo-security-scan-4.docgen
115+
[ -f ../gloo/docs/content/static/content/gloo-security-scan.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan.docgen static/content/gg-security-updates/gloo-security-scan.docgen
116+
[ -f ../gloo/docs/content/static/content/gloo-security-scan-0.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-0.docgen static/content/gg-security-updates/gloo-security-scan-0.docgen
117+
[ -f ../gloo/docs/content/static/content/gloo-security-scan-1.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-1.docgen static/content/gg-security-updates/gloo-security-scan-1.docgen
118+
[ -f ../gloo/docs/content/static/content/gloo-security-scan-2.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-2.docgen static/content/gg-security-updates/gloo-security-scan-2.docgen
119+
[ -f ../gloo/docs/content/static/content/gloo-security-scan-3.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-3.docgen static/content/gg-security-updates/gloo-security-scan-3.docgen
120+
[ -f ../gloo/docs/content/static/content/gloo-security-scan-4.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-4.docgen static/content/gg-security-updates/gloo-security-scan-4.docgen
119121
# Enterprise
120-
cp ../gloo/docs/content/static/content/glooe-security-scan.docgen static/content/gg-security-updates/glooe-security-scan.docgen
121-
cp ../gloo/docs/content/static/content/glooe-security-scan-0.docgen static/content/gg-security-updates/glooe-security-scan-0.docgen
122-
cp ../gloo/docs/content/static/content/glooe-security-scan-1.docgen static/content/gg-security-updates/glooe-security-scan-1.docgen
123-
cp ../gloo/docs/content/static/content/glooe-security-scan-2.docgen static/content/gg-security-updates/glooe-security-scan-2.docgen
124-
cp ../gloo/docs/content/static/content/glooe-security-scan-3.docgen static/content/gg-security-updates/glooe-security-scan-3.docgen
125-
cp ../gloo/docs/content/static/content/glooe-security-scan-4.docgen static/content/gg-security-updates/glooe-security-scan-4.docgen
122+
[ -f ../gloo/docs/content/static/content/glooe-security-scan.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan.docgen static/content/gg-security-updates/glooe-security-scan.docgen
123+
[ -f ../gloo/docs/content/static/content/glooe-security-scan-0.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-0.docgen static/content/gg-security-updates/glooe-security-scan-0.docgen
124+
[ -f ../gloo/docs/content/static/content/glooe-security-scan-1.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-1.docgen static/content/gg-security-updates/glooe-security-scan-1.docgen
125+
[ -f ../gloo/docs/content/static/content/glooe-security-scan-2.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-2.docgen static/content/gg-security-updates/glooe-security-scan-2.docgen
126+
[ -f ../gloo/docs/content/static/content/glooe-security-scan-3.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-3.docgen static/content/gg-security-updates/glooe-security-scan-3.docgen
127+
[ -f ../gloo/docs/content/static/content/glooe-security-scan-4.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-4.docgen static/content/gg-security-updates/glooe-security-scan-4.docgen
126128
popd || exit 1
127129
- name: Copy security posture
128130
run: |
@@ -151,6 +153,14 @@ jobs:
151153
cp ../gloo/docs/content/reference/cli/glooctl_uninstall.md content/en/gateway/${{ steps.version-variables.outputs.directory }}/reference/cli/glooctl_uninstall.md
152154
cp ../gloo/docs/content/reference/cli/glooctl_upgrade.md content/en/gateway/${{ steps.version-variables.outputs.directory }}/reference/cli/glooctl_upgrade.md
153155
popd || exit 1
156+
- name: Copy API
157+
run: |
158+
pushd docs || exit 1
159+
cp ../gloo/docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/direct_responses.md assets/conrefs/pages/gateway/reference/direct_responses_${{ steps.version-variables.outputs.minor }}.md
160+
sed -i '1,2d' assets/conrefs/pages/gateway/reference/direct_responses_${{ steps.version-variables.outputs.minor }}.md
161+
cp ../gloo/docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/gateway_parameters.md assets/conrefs/pages/gateway/reference/gateway_parameters_${{ steps.version-variables.outputs.minor }}.md
162+
sed -i '1,2d' assets/conrefs/pages/gateway/reference/gateway_parameters_${{ steps.version-variables.outputs.minor }}.md
163+
popd || exit 1
154164
- name: Push and create PR
155165
env:
156166
GITHUB_TOKEN: ${{ secrets.DOCS_TOKEN }}

changelog/v1.18.3/docs-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 backport of doc fixes, such as links, typos, version bumps, and minor Slack requests.
5+
skipCI-kube-tests:true

docs/content/guides/graphql/observability.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,7 @@ If you encounter errors or unexpected behavior in your Gloo GraphQL setup, you c
6969
{{< /highlight >}}
7070

7171
3. Use the following command. Logs are now collected for your GraphQL resources, and are served by the gateway proxy pod.
72+
7273
```sh
73-
glooctl proxy logs debug
74+
glooctl proxy logs --name gateway-proxy debug
75+
```

docs/content/introduction/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ You can then compare the output to what the Envoy config should look like.
398398
If you want to quickly get the logs for the proxy:
399399

400400
```bash
401-
glooctl proxy logs -f
401+
glooctl proxy logs --name gateway-proxy -f
402402
```
403403

404404
### Why are the ports on my gateway proxy not opened?

docs/content/operations/debugging_gloo/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Finally, you can use the Solo.io Envoy UI to browse the config. You can safely u
167167
If things look okay (within your ability to tell), another good place to look is the Envoy proxy logs. You can very quickly turn on `debug` logging to Envoy as well as `tail` the logs with this handy `glooctl` command:
168168
169169
```bash
170-
glooctl proxy logs -f
170+
glooctl proxy logs --name gateway-proxy -f
171171
```
172172
173173
When you have the logging window up, send requests through to the proxy and you can get some very detailed debugging logging going through the log tail.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0
1+
1.18.1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0
1+
1.18.1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.4
1+
1.17.5
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.3
1+
1.17.4
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0
1+
1.18.2
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.16
1+
1.17.19

0 commit comments

Comments
 (0)