Skip to content

Commit

Permalink
Merge pull request #23 from homarr-labs/22-feat-sync-docs-with-github…
Browse files Browse the repository at this point in the history
…-actions

ci(docs): sync helm chart doc with Homarr documentation repo
  • Loading branch information
oben01 authored Dec 31, 2024
2 parents 87b56c2 + 3b72bee commit d7533c5
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/sync-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Sync Helm Chart Docs to Homarr documentation Repo

on:
push:
branches:
- dev

jobs:
sync-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout helm chart Repo
uses: actions/checkout@v4
with:
sparse-checkout: |
charts/homarr/README.md
sparse-checkout-cone-mode: false

- name: Checkout Homarr documentation Repo
uses: actions/checkout@v4
with:
repository: homarr-labs/documentation
path: target-repo
# TODO: Change to the main branch on stable release
ref: docs/version-1.0

- name: Sync Documentation
run: |
cp charts/homarr/README.md target-repo/docs/getting-started/installation/helm.md
cd target-repo
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add .
git commit -m "docs(helm): Update Helm chart documentation" || echo "No changes to commit"
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.REPO_ACCESS_TOKEN }}
branch: update-helm-docs
# TODO: Change to the main branch on stable release
base: docs/version-1.0
title: Update Helm chart documentation
delete-branch: true
body: |
This PR updates the documentation file to match the latest Helm chart changes.
labels: |
helm
docs

0 comments on commit d7533c5

Please sign in to comment.