Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioning charts for docs #279

Merged
merged 24 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
cb2e701
Add workflows for automatic documentation updates with versioning
KastTrifork Oct 23, 2024
9cca2c9
Test action
KastTrifork Oct 23, 2024
a0c07a2
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
d64dfb3
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
1caed54
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
d9bf3ba
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
56bef77
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
f0dbef4
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
d218c16
Update workflow to use correct repository for updating TOC file
KastTrifork Oct 23, 2024
eff75fc
Update TOC file with new repository entries
KastTrifork Oct 23, 2024
73948f3
Merge branch 'main' into versioning-charts-for-docs
KastTrifork Oct 23, 2024
3aebab9
Update toc file with new version v0.8.0 for cheetah-application (#280)
cheetahbot Oct 23, 2024
5456044
Create path for docs
KastTrifork Oct 23, 2024
ac3aba7
Cleared toc file and uses another branch for update-toc action
KastTrifork Oct 31, 2024
c980d13
Update toc file with new version v0.8.0 for cheetah-application (#281)
cheetahbot Oct 31, 2024
cae11d5
Update doc-publish.yml to fix file paths for GitHub Pages deployment
KastTrifork Oct 31, 2024
cff669b
Fix file paths for GitHub Pages deployment in doc-publish.yml and try…
KastTrifork Oct 31, 2024
64b877f
Update toc file with new version v2.1.0 for flink-job (#282)
cheetahbot Oct 31, 2024
e58ea1b
Update toc file with new version v0.2.0 for image-automation (#283)
cheetahbot Oct 31, 2024
642739b
Update toc file with new version v0.3.0 for opensearchrole (#284)
cheetahbot Oct 31, 2024
97f9e27
Update toc file with new version v1.1.0 for redpanda-console-oauth2pr…
cheetahbot Oct 31, 2024
c1120e2
Update toc file with new version v1.1.0 for redpanda-console-oauth2pr…
cheetahbot Oct 31, 2024
3897d29
Ready for release
KastTrifork Oct 31, 2024
65a8a89
Update action to use main branch
KastTrifork Oct 31, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
- name: cheetah-application
items:
- name: v0.8
href: cheetah-application/v0.8/README.md
- name: flink-job
items:
- name: v2.1
href: flink-job/v2.1/README.md
- name: image-automation
items:
- name: v0.2
href: image-automation/v0.2/README.md
- name: opensearchrole
items:
- name: v0.3
href: opensearchrole/v0.3/README.md
- name: redpanda-console-oauth2proxy
items:
- name: v1.1
href: redpanda-console-oauth2proxy/v1.1/README.md
17 changes: 9 additions & 8 deletions .github/workflows/doc-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,28 @@ jobs:

- name: create public/
run: |
mkdir -p public/
cp charts/${{ inputs.chart}}/README.md public/${{inputs.chart}}
mkdir -p public/docs/${{ inputs.chart }}/
cp charts/${{ inputs.chart }}/README.md public/docs/${{ inputs.chart }}
cp README.md public/docs

- name: Deploy to GitHub Pages
id: deployment
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public/${{inputs.chart}}
publish_dir: ./public/docs/
exclude_assets: ""
destination_dir: charts/${{ inputs.chart }}/v${{ steps.chart.outputs.version }}
commit_message: "Deploy ${{ steps.chart.outputs.version }}"
destination_dir: docs/${{ inputs.chart }}/v${{ steps.chart.outputs.version }}
commit_message: "Deploy docs for version v${{ steps.chart.outputs.version }}"
keep_files: true

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public/README.md
exclude_assets: ""
commit_message: "Deploy README.md for repository"
publish_dir: .
exclude_assets: './public/docs, ./toc-folder'
commit_message: "Deploy repo to gh pages"
keep_files: true

- name: Repository Dispatch
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/update-docs-auto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ jobs:
charts/cheetah-application/*.yaml

- name: Set output variable
#if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
run: |
echo "changed=true" >> $GITHUB_ENV
outputs:
changed: ${{ steps.changed-files.outputs.any_changed }}

update-doc-cheetah-application:
#if: ${{ needs.cheetah-application.outputs.changed == 'true' }}
if: ${{ needs.cheetah-application.outputs.changed == 'true' }}
needs: cheetah-application
uses: ./.github/workflows/doc-publish.yml
with:
Expand Down