Skip to content

Commit f14fa86

Browse files
committed
test actions
1 parent 81460f3 commit f14fa86

2 files changed

Lines changed: 117 additions & 0 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Generate Keyword Documentation
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
paths:
7+
- 'libraries/**'
8+
9+
jobs:
10+
generate-docs:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write # Required for committing documentation
14+
steps:
15+
- uses: actions/checkout@v3
16+
with:
17+
ref: ${{ github.event.pull_request.head.sha }} # Checkout PR branch
18+
19+
- name: Generate Keyword Documentation
20+
uses: ./.github/actions/runwhen-keyword-docs-generator@keyword-doc-generator
21+
withname: Manual Documentation Generation
22+
23+
on:
24+
workflow_dispatch:
25+
inputs:
26+
doc_type:
27+
description: 'Type of documentation to generate'
28+
required: true
29+
default: 'markdown'
30+
type: choice
31+
options:
32+
- markdown
33+
- confluence
34+
- both
35+
libraries_path:
36+
description: 'Path to the libraries directory'
37+
required: false
38+
default: 'libraries'
39+
type: string
40+
41+
jobs:
42+
generate-docs:
43+
runs-on: ubuntu-latest
44+
permissions:
45+
contents: write
46+
steps:
47+
- uses: actions/checkout@v3
48+
49+
- name: Generate Keyword Documentation
50+
uses: ./.github/actions/runwhen-keyword-docs-generator@keyword-doc-generator
51+
with:
52+
doc_type: ${{ github.event.inputs.doc_type }}
53+
libraries_path: ${{ github.event.inputs.libraries_path }}
54+
55+
# Confluence settings (if needed)
56+
confluence_url: ${{ secrets.CONFLUENCE_URL }}
57+
confluence_username: ${{ secrets.CONFLUENCE_USERNAME }}
58+
confluence_api_token: ${{ secrets.CONFLUENCE_API_TOKEN }}
59+
confluence_space_key: ${{ secrets.CONFLUENCE_SPACE_KEY }}
60+
confluence_parent_page_id: ${{ secrets.CONFLUENCE_PARENT_PAGE_ID }}
61+
62+
# Git commit settings
63+
commit_changes: 'true'
64+
commit_message: 'docs: manual update of keyword documentation [skip ci]'
65+
# Documentation type (markdown, confluence, or both)
66+
doc_type: 'markdown' # Optional, defaults to 'markdown'
67+
68+
# Confluence settings (required only if doc_type is 'confluence' or 'both')
69+
confluence_url: 'https://your-domain.atlassian.net'
70+
confluence_username: ${{ secrets.CONFLUENCE_USERNAME }}
71+
confluence_api_token: ${{ secrets.CONFLUENCE_API_TOKEN }}
72+
confluence_space_key: 'YOUR_SPACE_KEY'
73+
confluence_parent_page_id: 'PARENT_PAGE_ID'
74+
75+
# Git commit settings
76+
commit_changes: 'true' # Optional, defaults to 'true'
77+
commit_message: 'docs: update keyword documentation [skip ci]' # Optional
78+
79+
# Optional settings
80+
libraries_path: 'libraries' # Optional, defaults to 'libraries'

.github/workflows/docs_pr.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Generate Keyword Documentation
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
paths:
7+
- 'libraries/**'
8+
9+
jobs:
10+
generate-docs:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write # Required for committing documentation
14+
steps:
15+
- uses: actions/checkout@v3
16+
with:
17+
ref: ${{ github.event.pull_request.head.sha }} # Checkout PR branch
18+
19+
- name: Generate Keyword Documentation
20+
uses: ./.github/actions/runwhen-keyword-docs-generator@keyword-doc-generator
21+
with:
22+
# Documentation type (markdown, confluence, or both)
23+
doc_type: 'markdown' # Optional, defaults to 'markdown'
24+
25+
# Confluence settings (required only if doc_type is 'confluence' or 'both')
26+
confluence_url: 'https://your-domain.atlassian.net'
27+
confluence_username: ${{ secrets.CONFLUENCE_USERNAME }}
28+
confluence_api_token: ${{ secrets.CONFLUENCE_API_TOKEN }}
29+
confluence_space_key: 'YOUR_SPACE_KEY'
30+
confluence_parent_page_id: 'PARENT_PAGE_ID'
31+
32+
# Git commit settings
33+
commit_changes: 'true' # Optional, defaults to 'true'
34+
commit_message: 'docs: update keyword documentation [skip ci]' # Optional
35+
36+
# Optional settings
37+
libraries_path: 'libraries' # Optional, defaults to 'libraries'

0 commit comments

Comments
 (0)