7
7
- ' .github/workflows/**'
8
8
workflow_dispatch :
9
9
inputs :
10
- version :
11
- description : ' Version of library that is being documented'
10
+ dokka_artifact_url :
11
+ description : ' URL of Dokka artifact.'
12
+ required : true
13
+ dry_run :
14
+ type : boolean
15
+ description : " Dry run. If set to true, the action will not actually publish the pages, but will assemble the artifact."
16
+ default : true
12
17
required : true
13
18
14
19
permissions :
@@ -90,10 +95,21 @@ jobs:
90
95
run : unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
91
96
92
97
- name : Download Dokka
93
- uses : actions/download-artifact@v4
94
- with :
95
- name : dokka-${{ inputs.version }}
96
- path : ${{ env.DOKKA_ARTIFACT }}
98
+ run : |
99
+ if [ -z "${{ inputs.dokka_artifact_url }}" ]; then
100
+ echo "'dokka_artifact_url' is not set"
101
+ exit 1
102
+ fi
103
+
104
+ if [ ${{ inputs.dry_run }} == true ]; then
105
+ echo "Dry run mode is enabled."
106
+ curl -v -s -f -L \
107
+ -H "Authorization: Bearer ${{ secrets.TEAMCITY_TOKEN }}" \
108
+ ${{ inputs.dokka_artifact_url }} -o ${{ env.DOKKA_ARTIFACT }}
109
+ else
110
+ curl -v -s -f -L \
111
+ ${{ inputs.dokka_artifact_url }} -o ${{ env.DOKKA_ARTIFACT }}
112
+ fi
97
113
98
114
- name : Unzip Dokka
99
115
run : unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api
@@ -110,7 +126,7 @@ jobs:
110
126
retention-days : 7
111
127
112
128
deploy :
113
- if : github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
129
+ if : github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
114
130
environment :
115
131
name : github-pages
116
132
url : ${{ steps.deployment.outputs.page_url }}
@@ -138,7 +154,7 @@ jobs:
138
154
uses : actions/deploy-pages@v4
139
155
140
156
publish-indexes :
141
- if : github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
157
+ if : github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
142
158
needs : [ build, test, assemble, deploy ]
143
159
runs-on : ubuntu-latest
144
160
container :
0 commit comments