From 69b80343ddba88ec9b6610a21977586f5b388040 Mon Sep 17 00:00:00 2001 From: Igor Pecovnik Date: Mon, 30 Sep 2024 13:41:28 +0200 Subject: [PATCH] Add action for generation documentation --- .github/workflows/docs.yml | 39 ++++++++++++++++++++++++++ lib/armbian-configng/config.ng.docs.sh | 2 +- 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..7ca0ceb8 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,39 @@ +name: "Regenerate documentation" + +on: + push: + workflow_dispatch: + +jobs: + + Build: + name: Make docs + runs-on: ubuntu-latest + #if: ${{ github.repository_owner == 'armbian' }} + steps: + + - name: Checkout build repo + uses: actions/checkout@v4 + - name: Make docs + run: | + bin/armbian-configng --doc + + - name: Create Pull Request + id: cpr + uses: peter-evans/create-pull-request@v6 + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: '`Automatic` documentation update' + signoff: false + branch: update-docs + delete-branch: true + title: '`Automatic` documentation update' + body: | + Generate documentation. + + labels: | + Needs review + #assignees: igorpecovnik + #reviewers: Must be org collaborator + draft: false + diff --git a/lib/armbian-configng/config.ng.docs.sh b/lib/armbian-configng/config.ng.docs.sh index cf3bb46d..194f2863 100644 --- a/lib/armbian-configng/config.ng.docs.sh +++ b/lib/armbian-configng/config.ng.docs.sh @@ -23,7 +23,7 @@ function generate_readme() { echo -e "Sorting data\nUpdating documentation" # current_date ; - cat << EOF > "$script_dir/../README.md" + cat << EOF > "$script_dir/../DOCUMENTATION.md" # Armbian Configuration Utility Updated: $current_date