Skip to content

Commit

Permalink
Add action for generation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpecovnik committed Sep 30, 2024
1 parent bd256bc commit 69b8034
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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

2 changes: 1 addition & 1 deletion lib/armbian-configng/config.ng.docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 69b8034

Please sign in to comment.