2022-07-15 04:23:52 -04:00
|
|
|
name: Publish CLI reference to documentation
|
|
|
|
on:
|
2022-10-12 04:50:06 -04:00
|
|
|
workflow_dispatch:
|
2022-07-15 04:23:52 -04:00
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- main
|
2022-10-18 10:17:41 -04:00
|
|
|
- "release/**"
|
2022-09-03 11:47:47 -04:00
|
|
|
paths:
|
2022-09-09 04:26:25 -04:00
|
|
|
- "cli/cmd/**"
|
|
|
|
- "cli/internal/cmd/**"
|
2022-09-16 09:46:23 -04:00
|
|
|
- "hack/clidocgen/**"
|
2022-07-15 04:23:52 -04:00
|
|
|
|
|
|
|
jobs:
|
|
|
|
publish-to-docs:
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
|
|
|
steps:
|
|
|
|
- name: Checkout Constellation
|
2022-10-12 12:05:58 -04:00
|
|
|
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3.1.0
|
2022-07-15 04:23:52 -04:00
|
|
|
|
2022-09-14 09:14:26 -04:00
|
|
|
- name: Setup Go environment
|
2022-10-18 07:54:53 -04:00
|
|
|
uses: actions/setup-go@c4a742cab115ed795e34d4513e2cf7d472deb55f # tag=v3.3.1
|
2022-07-15 04:23:52 -04:00
|
|
|
with:
|
2022-10-06 13:31:12 -04:00
|
|
|
go-version: "1.19.2"
|
2022-09-14 09:14:26 -04:00
|
|
|
cache: true
|
2022-07-15 04:23:52 -04:00
|
|
|
|
|
|
|
- name: Generate reference docs
|
2022-09-09 05:19:28 -04:00
|
|
|
run: go run . | cat header.md - > ../../cli.md
|
|
|
|
working-directory: hack/clidocgen
|
2022-07-15 04:23:52 -04:00
|
|
|
|
|
|
|
- name: Get commit sha
|
|
|
|
run: |
|
|
|
|
echo "COMMIT_END=$(echo ${{ github.sha }} | cut -c1-8)" >> $GITHUB_ENV
|
|
|
|
|
|
|
|
- name: Check if action branch exists
|
|
|
|
run: |
|
2022-09-09 04:32:37 -04:00
|
|
|
ex=$(git ls-remote --heads origin action/constellation/update-cli-reference)
|
2022-07-15 04:23:52 -04:00
|
|
|
echo "EXISTS=$(if [ -z "$ex" ]; then echo 0; else echo 1; fi)" >> $GITHUB_ENV
|
|
|
|
|
|
|
|
- name: Publish new reference (create new branch)
|
|
|
|
if: ${{ env.EXISTS == 0 }}
|
2022-10-12 12:05:58 -04:00
|
|
|
uses: dmnemec/copy_file_to_another_repo_action@c93037aa10fa8893de271f19978c980d0c1a9b37 # tag=v1.1.1
|
2022-07-15 04:23:52 -04:00
|
|
|
env:
|
|
|
|
API_TOKEN_GITHUB: ${{ secrets.CI_GITHUB_REPOSITORY }}
|
|
|
|
with:
|
2022-09-09 04:26:25 -04:00
|
|
|
source_file: "cli.md"
|
|
|
|
destination_repo: "edgelesssys/constellation"
|
|
|
|
destination_branch_create: "action/constellation/update-cli-reference"
|
|
|
|
destination_folder: "docs/docs/reference"
|
|
|
|
user_name: "${{ github.actor }}"
|
|
|
|
user_email: "${{ github.actor }}@users.noreply.github.com"
|
|
|
|
commit_message: "CLI reference was updated by edgelesssys/constellation@${{ env.COMMIT_END}}"
|
2022-07-15 04:23:52 -04:00
|
|
|
|
|
|
|
- name: Publish new reference (update branch)
|
|
|
|
if: ${{ env.EXISTS == 1 }}
|
2022-10-12 12:05:58 -04:00
|
|
|
uses: dmnemec/copy_file_to_another_repo_action@c93037aa10fa8893de271f19978c980d0c1a9b37 # tag=v1.1.1
|
2022-07-15 04:23:52 -04:00
|
|
|
env:
|
|
|
|
API_TOKEN_GITHUB: ${{ secrets.CI_GITHUB_REPOSITORY }}
|
|
|
|
with:
|
2022-09-09 04:26:25 -04:00
|
|
|
source_file: "cli.md"
|
|
|
|
destination_repo: "edgelesssys/constellation"
|
|
|
|
destination_branch: "action/constellation/update-cli-reference"
|
|
|
|
destination_folder: "docs/docs/reference"
|
|
|
|
user_name: "${{ github.actor }}"
|
|
|
|
user_email: "${{ github.actor }}@users.noreply.github.com"
|
|
|
|
commit_message: "CLI reference was updated by edgelesssys/constellation@${{ env.COMMIT_END}}"
|