Skip to content

Commit 545fd41

Browse files
committed
chore: add docc generation step to release.yml
1 parent eb1ee8c commit 545fd41

1 file changed

Lines changed: 39 additions & 1 deletion

File tree

.github/workflows/release.yml

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,42 @@ jobs:
9999
name: ${{ steps.next-version.outputs.NEXT_VERSION }}
100100
tag_name: ${{ steps.next-version.outputs.NEXT_VERSION }}
101101
body: ${{ steps.release-notes.outputs.RELEASE_NOTES }}
102-
target_commitish: ${{ steps.auto-commit-action.outputs.commit_hash }}
102+
target_commitish: ${{ steps.auto-commit-action.outputs.commit_hash }}
103+
104+
docc:
105+
name: build and deploy docc
106+
runs-on: macos-latest
107+
needs: release
108+
if: ${{ needs.release.outputs.has-changes == 'true' }}
109+
timeout-minutes: 15
110+
steps:
111+
- uses: actions/checkout@v6
112+
with:
113+
ref: ${{ needs.release.outputs.commit-hash }}
114+
fetch-depth: 0
115+
- name: Build DocC
116+
id: build
117+
uses: space-code/build-docc@main
118+
with:
119+
schemes: '["Typhoon"]'
120+
version: ${{ needs.release.outputs.next-version }}
121+
- name: Generate Index Page
122+
uses: space-code/generate-index@v1.0.0
123+
with:
124+
version: ${{ needs.release.outputs.next-version }}
125+
project-name: 'Typhoon'
126+
project-description: 'Typhoon is a modern, lightweight Swift framework that provides elegant and robust retry policies for asynchronous operations.'
127+
modules: |
128+
[
129+
{
130+
"name": "Typhoon",
131+
"path": "typhoon",
132+
"description": "Core retry mechanisms and policies for asynchronous operations. Includes retry strategies, backoff algorithms, and cancellation support.",
133+
"badge": "Core Module"
134+
}
135+
]
136+
- name: Deploy
137+
uses: peaceiris/actions-gh-pages@v4
138+
with:
139+
github_token: ${{ secrets.GITHUB_TOKEN }}
140+
publish_dir: ./docs

0 commit comments

Comments
 (0)