You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,3 +138,29 @@ To build the documentation from the current clone, using any worktrees that are
138
138
--
139
139
140
140
. Navigate to _$HOME/spring-security/docs-site/build/site/index.html_ to view the generated documentation.
141
+
142
+
[#trigger]
143
+
== Trigger the documentation build workflow (docs manager)
144
+
145
+
You can either trigger the production document build using the Deploy Docs entry in the GitHub Actions web UI or using the https://cli.github.com/[GitHub CLI].
146
+
147
+
=== GitHub Actions web UI
148
+
149
+
In the GitHub Actions web UI, click the Deploy Docs entry.
150
+
Click on the "Run workflow" menu.
151
+
Select the branch `docs-build` and click "Run workflow" to trigger a full build.
152
+
To trigger a partial build, specify a release line branch name in the input field labeled "Enter git refname to build".
153
+
154
+
=== GitHub CLI
155
+
156
+
Starting from within the cloned repository (ideally the playbook branch), here's how to trigger a full build of the documentation site using the `gh` command:
157
+
158
+
$ gh workflow run deploy-docs.yml --ref docs-build
159
+
160
+
Here's how to trigger a partial build of a single version (based on the release line branch name):
161
+
162
+
$ gh workflow run deploy-docs.yml --ref docs-build -f build-refname=5.7.x
163
+
164
+
Run `gh help workflow run` to show the docs for this command and other examples of how to use it.
165
+
166
+
If you're not running the `gh` command from within the cloned repository, you can specify the repository using the `--repo` CLI option (e.g., `--repo spring-projects/spring-security`).
0 commit comments