Skip to content

Merge pull request #172 from jat-canonical/update-juju-version #17

Merge pull request #172 from jat-canonical/update-juju-version

Merge pull request #172 from jat-canonical/update-juju-version #17

name: Automatically generate command reference topics
on:
push:
workflow_dispatch:
env:
AMC_COMMAND_REFERENCE_DIR: "./reference/cmd-ref/amc"
APPLIANCE_COMMAND_REFERENCE_DIR: "./reference/cmd-ref/appliance"
jobs:
run-tests:
runs-on: ubuntu-24.04
steps:
- name: Determine base version
id: base_version
run: |
echo "value=$(cat .base_version)" >> "$GITHUB_OUTPUT"
- name: Set up Anbox Cloud
uses: canonical/anbox-cloud-github-action@39490d442cc0921fe614f7044b9f3dc8bd89725c
with:
channel: ${{ steps.base_version.outputs.value }}/stable
- name: Checkout repo
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
# Remove existing files, generate AMC command reference
- name: Generate AMC command reference documentation
run: |
set -e
# Remove existing files, generate AMC command reference
rm -rf $AMC_COMMAND_REFERENCE_DIR/*
amc generate documentation -f markdown -d $AMC_COMMAND_REFERENCE_DIR
- name: Generate appliance command reference documentation
env:
SNAP_DOCS_DIR: "/var/snap/anbox-cloud-appliance/common/docs"
run: |
set -e
# Remove existing files, generate appliance command reference
rm -rf $APPLIANCE_COMMAND_REFERENCE_DIR/*
# For the appliance command, the files have to be generated inside the Snap
# and then copied to the desired directory because of Snap confinement
sudo mkdir -p $SNAP_DOCS_DIR
sudo anbox-cloud-appliance generate documentation -f markdown -d $SNAP_DOCS_DIR
cp -r $SNAP_DOCS_DIR/* $APPLIANCE_COMMAND_REFERENCE_DIR
- name: Create pull request
uses: canonical/create-pull-request@8f6ac18065716982f3970ef7d6d584bed1b4cbe3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "Commit changes to command reference documentation"
branch-name: update-cmd-ref
title: Update command reference documentation
body: |
This updates the command reference topics for the AMC and Anbox Cloud Appliance.
repository: canonical/anbox-cloud-docs
upsert: true
ignore-no-changes: true