Skip to content

Commit f832e49

Browse files
committed
[#1951] Added a command to automatically create installer ascii video and PNG screenshot.
1 parent ffaa5db commit f832e49

29 files changed

Lines changed: 1701 additions & 206 deletions

.github/workflows/vortex-release-docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,12 @@ jobs:
132132
run: yarn run build
133133
working-directory: .vortex/docs
134134

135+
- name: Generate video for installer (not used in the final artifact)
136+
run: |
137+
sudo apt install asciinema expect
138+
./update-installer-video.sh
139+
working-directory: .vortex/docs/.utils
140+
135141
- name: Upload documentation site
136142
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
137143
with:

.github/workflows/vortex-test-installer.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ jobs:
3030
coverage: pcov
3131
ini-values: pcov.directory=.
3232

33+
- name: Setup Node.js
34+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
35+
with:
36+
node-version: 22.17.1
37+
3338
- name: Set default branch name
3439
run: git config --global init.defaultBranch >/dev/null || git config --global init.defaultBranch "main"
3540

@@ -51,6 +56,12 @@ jobs:
5156
env:
5257
GITHUB_TOKEN: ${{ secrets.PACKAGE_TOKEN }}
5358

59+
- name: Generate video for installer (not used in the final artifact)
60+
run: |
61+
sudo apt install asciinema expect
62+
./update-installer-video.sh
63+
working-directory: .vortex/docs/.utils
64+
5465
- name: Upload coverage reports as an artifact
5566
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
5667
with:

.vortex/.ahoy.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,12 @@ commands:
107107
composer --working-dir=./docs/.utils install
108108
yarn --cwd=docs run update-variables
109109
110+
update-installer-video:
111+
usage: Update installer video in the documentation.
112+
cmd: |
113+
cd docs/.utils
114+
./update-installer-video.sh
115+
110116
entrypoint:
111117
- bash
112118
- "-c"

.vortex/docs/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@
2020
npm-debug.log*
2121
yarn-debug.log*
2222
yarn-error.log*
23+
24+
# Copied installer file.
25+
static/install

.vortex/docs/.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ coverage/
55
yarn.lock
66
package-lock.json
77
*.md
8-
*.mdx
8+
*.mdx
9+
tests/fixtures/*.json

0 commit comments

Comments
 (0)