From 171f8a6311fd2dc845c5e4768da7bf6eec8b64e8 Mon Sep 17 00:00:00 2001 From: Tim Middleton Date: Fri, 21 Feb 2025 11:21:55 +0800 Subject: [PATCH] Update docs and release script to create docs.zip --- .github/workflows/release.yml | 17 ++++++++++++++++- .gitignore | 2 ++ docs/about/overview.adoc | 14 ++++++++++++++ 3 files changed, 32 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 48141d83..2f780c7d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -60,7 +60,12 @@ jobs: - name: Build Docs shell: bash - run: make docs + run: | + make docs + DIR=`pwd` + cd build/_output/docs + zip -r ../docs.zip * + cd $DIR - name: Build Binaries shell: bash @@ -144,6 +149,16 @@ jobs: asset_name: cohctl-${{ steps.version.outputs.version }}-windows-arm.exe asset_content_type: application/x-dosexec + - name: Upload docs.zip + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ github.token }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: ./build/_output/docs.zip + asset_name: docs.zip + asset_content_type: application/zip + - uses: actions/upload-artifact@v4 if: failure() with: diff --git a/.gitignore b/.gitignore index 6378a59c..8f530e43 100644 --- a/.gitignore +++ b/.gitignore @@ -39,3 +39,5 @@ build/ shared/ release/ test/test_utils/certs/ + +utils/linkcheck/go.sum diff --git a/docs/about/overview.adoc b/docs/about/overview.adoc index 1fa3f81d..90a8ceaf 100644 --- a/docs/about/overview.adoc +++ b/docs/about/overview.adoc @@ -36,6 +36,13 @@ Installing the Coherence CLI for your platform. Quick start guide to getting started with the Coherence CLI. -- +==== + +== Configuration and Commands + +[PILLARS] +==== + [CARD] .Configuration [icon=fa-cogs,link=../config/overview.adoc] @@ -57,6 +64,13 @@ Coherence CLI Command Reference. Securing CLI access. -- +==== + +== Troubleshooting and Examples + +[PILLARS] +==== + [CARD] .Troubleshooting [icon=fa-question-circle,link=../troubleshooting/trouble-shooting.adoc]