Skip to content

Commit 6349d8b

Browse files
authored
Merge pull request #13 from eqtylab/gov-220
GOV-220: Retire deployment docsite sources
2 parents fe0d6d6 + 12481b9 commit 6349d8b

16 files changed

Lines changed: 105 additions & 321 deletions

.github/workflows/docsite-ci.yaml

Lines changed: 0 additions & 104 deletions
This file was deleted.

.github/workflows/helm-ci.yaml

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ on:
77
- ".github/workflows/helm-ci.yaml"
88
- "charts/**"
99
- "releases/**"
10-
- "docs-site/**"
1110
- "schemas/**"
1211
push:
1312
branches:
@@ -16,7 +15,6 @@ on:
1615
- ".github/workflows/helm-ci.yaml"
1716
- "charts/**"
1817
- "releases/**"
19-
- "docs-site/**"
2018
- "schemas/**"
2119
workflow_dispatch:
2220

@@ -136,6 +134,9 @@ jobs:
136134
137135
validation_mode="$(yq '.validation.mode' "$manifest")"
138136
validation_status="$(yq '.validation.evidence.status' "$manifest")"
137+
docs_provider="$(yq '.docs.provider // ""' "$manifest")"
138+
docs_version="$(yq '.docs.version // ""' "$manifest")"
139+
docs_state="$(yq '.docs.state // ""' "$manifest")"
139140
140141
if [ "$validation_mode" != "manual" ]; then
141142
echo "::error file=${manifest}::validation.mode must be manual"
@@ -150,6 +151,51 @@ jobs:
150151
;;
151152
esac
152153
154+
case "$docs_provider" in
155+
readme|self-hosted) ;;
156+
*)
157+
echo "::error file=${manifest}::docs.provider must be readme or self-hosted"
158+
exit 1
159+
;;
160+
esac
161+
162+
if [ -z "$docs_version" ] || [ "$docs_version" = "null" ]; then
163+
echo "::error file=${manifest}::docs.version is required"
164+
exit 1
165+
fi
166+
167+
case "$docs_state" in
168+
beta|public|hidden|deprecated) ;;
169+
*)
170+
echo "::error file=${manifest}::docs.state must be beta, public, hidden, or deprecated"
171+
exit 1
172+
;;
173+
esac
174+
175+
if [ "$docs_provider" = "self-hosted" ]; then
176+
docs_source_repo="$(yq '.docs.sourceRepository // ""' "$manifest")"
177+
docs_source_commit="$(yq '.docs.sourceCommit // ""' "$manifest")"
178+
docs_source_format="$(yq '.docs.sourceFormat // ""' "$manifest")"
179+
docs_workflow_run_url="$(yq '.docs.workflowRunUrl // ""' "$manifest")"
180+
181+
if [ "$docs_source_repo" != "eqtylab/governance-platform-docs" ]; then
182+
echo "::error file=${manifest}::self-hosted docs must set docs.sourceRepository=eqtylab/governance-platform-docs"
183+
exit 1
184+
fi
185+
if [ "$docs_source_format" != "mdx" ]; then
186+
echo "::error file=${manifest}::self-hosted docs must set docs.sourceFormat=mdx"
187+
exit 1
188+
fi
189+
if [ -z "$docs_source_commit" ] || [ "$docs_source_commit" = "null" ]; then
190+
echo "::error file=${manifest}::self-hosted docs must set docs.sourceCommit"
191+
exit 1
192+
fi
193+
if [ -z "$docs_workflow_run_url" ] || [ "$docs_workflow_run_url" = "null" ]; then
194+
echo "::error file=${manifest}::self-hosted docs must set docs.workflowRunUrl"
195+
exit 1
196+
fi
197+
fi
198+
153199
images=(authService governanceService governanceStudio integrityService)
154200
if [ "$(yq '.charts.eqtyPdfgen.name // ""' "$manifest")" = "eqty-pdfgen" ]; then
155201
images+=(eqtyPdfgen)
@@ -194,7 +240,7 @@ jobs:
194240
195241
- name: Prevent latest image tags in release-facing files
196242
run: |
197-
if grep -RIn --include='*.yaml' --include='*.yml' --include='*.md' ':latest' charts releases docs-site 2>/dev/null; then
243+
if grep -RIn --include='*.yaml' --include='*.yml' --include='*.md' ':latest' charts releases 2>/dev/null; then
198244
echo "::error::Customer release files must not reference latest image tags."
199245
exit 1
200246
fi

.github/workflows/release-platform-package.yaml

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,55 @@ jobs:
151151
fi
152152
done
153153
154+
docs_provider="$(yq '.docs.provider // ""' "$MANIFEST")"
155+
docs_version="$(yq '.docs.version // ""' "$MANIFEST")"
156+
docs_state="$(yq '.docs.state // ""' "$MANIFEST")"
157+
158+
case "$docs_provider" in
159+
readme|self-hosted) ;;
160+
*)
161+
echo "::error file=${MANIFEST}::docs.provider must be readme or self-hosted."
162+
exit 1
163+
;;
164+
esac
165+
166+
if [ -z "$docs_version" ] || [ "$docs_version" = "null" ]; then
167+
echo "::error file=${MANIFEST}::docs.version is required."
168+
exit 1
169+
fi
170+
171+
case "$docs_state" in
172+
beta|public|hidden|deprecated) ;;
173+
*)
174+
echo "::error file=${MANIFEST}::docs.state must be beta, public, hidden, or deprecated."
175+
exit 1
176+
;;
177+
esac
178+
179+
if [ "$docs_provider" = "self-hosted" ]; then
180+
docs_source_repo="$(yq '.docs.sourceRepository // ""' "$MANIFEST")"
181+
docs_source_commit="$(yq '.docs.sourceCommit // ""' "$MANIFEST")"
182+
docs_source_format="$(yq '.docs.sourceFormat // ""' "$MANIFEST")"
183+
docs_workflow_run_url="$(yq '.docs.workflowRunUrl // ""' "$MANIFEST")"
184+
185+
if [ "$docs_source_repo" != "eqtylab/governance-platform-docs" ]; then
186+
echo "::error file=${MANIFEST}::self-hosted docs must set docs.sourceRepository=eqtylab/governance-platform-docs."
187+
exit 1
188+
fi
189+
if [ "$docs_source_format" != "mdx" ]; then
190+
echo "::error file=${MANIFEST}::self-hosted docs must set docs.sourceFormat=mdx."
191+
exit 1
192+
fi
193+
if [ -z "$docs_source_commit" ] || [ "$docs_source_commit" = "null" ]; then
194+
echo "::error file=${MANIFEST}::self-hosted docs must set docs.sourceCommit."
195+
exit 1
196+
fi
197+
if [ -z "$docs_workflow_run_url" ] || [ "$docs_workflow_run_url" = "null" ]; then
198+
echo "::error file=${MANIFEST}::self-hosted docs must set docs.workflowRunUrl."
199+
exit 1
200+
fi
201+
fi
202+
154203
- name: Helm validation
155204
env:
156205
MANIFEST: ${{ steps.release.outputs.manifest }}
@@ -269,18 +318,14 @@ jobs:
269318
MANIFEST: ${{ steps.release.outputs.manifest }}
270319
run: |
271320
package_root="dist/governance-platform-v${VERSION}"
272-
mkdir -p "$package_root/charts" "$package_root/docs" "$package_root/examples"
321+
mkdir -p "$package_root/charts" "$package_root/examples"
273322
274323
cp "$MANIFEST" "$package_root/release-manifest.yaml"
275324
cp dist/chart-digests.yaml "$package_root/chart-digests.yaml"
276325
cp dist/charts/*.tgz "$package_root/charts/"
277326
cp dist/charts/*.sha256 "$package_root/charts/"
278327
cp -R charts/governance-platform/examples "$package_root/examples/governance-platform"
279328
280-
if [ -d docs-site ]; then
281-
cp -R docs-site "$package_root/docs/docs-site"
282-
fi
283-
284329
cat > "$package_root/INSTALL.md" <<EOF
285330
# Governance Platform v${VERSION}
286331

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Governance Platform Deployment
22

3-
[![Docsite CI](https://github.com/eqtylab/deployment/actions/workflows/docsite-ci.yaml/badge.svg)](https://github.com/eqtylab/deployment/actions/workflows/docsite-ci.yaml)
43
[![Helm CI](https://github.com/eqtylab/deployment/actions/workflows/helm-ci.yaml/badge.svg)](https://github.com/eqtylab/deployment/actions/workflows/helm-ci.yaml)
54
[![Release Platform Package](https://github.com/eqtylab/deployment/actions/workflows/release-platform-package.yaml/badge.svg)](https://github.com/eqtylab/deployment/actions/workflows/release-platform-package.yaml)
65

@@ -31,7 +30,6 @@
3130
- **[`releases/`](./releases/)** — Per-version release manifests pinning chart versions, image digests, and source refs for each platform release.
3231
- **[`containers/`](./containers/)** — Custom container image builds (e.g. patched PostgreSQL) used by the platform.
3332
- **[`schemas/`](./schemas/)** — JSON schemas for release manifests and other structured artifacts in this repo.
34-
- **[`docs-site/`](./docs-site/)** — Source for the hosted customer documentation site.
3533

3634
## 📦 Versioning
3735

docs-site/README.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs-site/readme/guides/install/airgap-install.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs-site/readme/guides/install/connected-install.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs-site/readme/guides/operate/known-issues.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs-site/readme/guides/release-overview.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)