Skip to content

Commit 81bd5dc

Browse files
committed
use the GHA built apidoc for foreman
1 parent bde270b commit 81bd5dc

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,17 @@ Follow these steps to add a new version:
1515

1616
Generate API docs in Foreman:
1717

18-
1. cd to foreman directory and checkout the relevant stable branch
19-
1. disable any plugins installed locally
20-
1. `APIPIE_RECORD=examples bundle exec rake test`
21-
1. `FOREMAN_APIPIE_LANGS=en bundle exec rake apipie:cache`
18+
1. Go to https://github.com/theforeman/foreman/actions/workflows/foreman.yml?query=branch%3AX.Y-stable
19+
1. Pick the latest run of the action
20+
1. Download the `apidoc-*` artifact (there might be multiple, pick any one of them)
2221

2322
Prepare folder for the new version (X.Y)
2423

2524
1. cd to foreman directory
2625
1. `cp -r TEMPLATE X.Y`
2726
1. `ln -snf X.Y latest`
28-
1. `cp -r dir/to/foreman/public/apipie-cache/apidoc/* X.Y/apidoc`
29-
1. run cleanup script in apidocs repo: `cleanup.sh`
27+
1. `unzip -d X.Y/apidoc ~/Downloads/apidoc-<…>.zip`
28+
1. run cleanup script in the root of the apidocs repo: `cleanup.sh`
3029
1. update index.html file with a link to the new page
3130

3231
### Katello

0 commit comments

Comments
 (0)