🌱 chore: update the asciinema demo creation script #5068
Conversation
k8s-ci-robot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: wazery The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
needs-ok-to-test
|
Hi @wazery. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
the
size/L
wazery
force-pushed
the
w-asciinema-demo
branch
3 times, most recently
from
ce9b9ee to
ada0506
Compare
wazery
changed the title
wazery
force-pushed
the
w-asciinema-demo
branch
2 times, most recently
from
b6ef9e6 to
2f5bdbe
Compare
wazery
changed the title
wazery
force-pushed
the
w-asciinema-demo
branch
2 times, most recently
from
b339d16 to
0e9254a
Compare
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
wazery
force-pushed
the
w-asciinema-demo
branch
from
0e9254a to
ee1f601
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the asciinema demo recording infrastructure for Kubebuilder by introducing automated demo generation capabilities, a Kind cluster setup script, and Makefile targets for easier workflow management.
Key Changes:
- Added automated demo recording and SVG generation pipeline
- Introduced Kind cluster setup automation for consistent demo environments
- Enhanced demo script with modern Kubebuilder features (deploy-image plugin, validation markers)
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/demo/setup-kind.sh | New script that automates Kind cluster setup with installation checks and cluster configuration |
| scripts/demo/run.sh | Updated demo workflow showcasing modern features like deploy-image plugin and validation markers |
| scripts/demo/generate-demo.sh | New orchestration script that automates recording, SVG conversion, and README updates |
| scripts/demo/README.md | Comprehensive documentation update with new targets, prerequisites, and workflow instructions |
| Makefile | Added three new targets (update-demo, setup-demo-cluster, clean-demo) for demo management |
Comments suppressed due to low confidence (1)
scripts/demo/setup-kind.sh:1
- The
uname -mcommands should be quoted to handle edge cases with spaces or special characters. Use[ "$(uname -m)" = x86_64 ]instead.
#!/usr/bin/env bash
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix kubectl apply command: change -k to -f for single YAML file - Extract duplicate version logic to main() function - Remove OS-specific installation commands from prerequisites - Simplify check_prerequisites error messages Addresses feedback from PR kubernetes-sigs#5068
wazery
force-pushed
the
w-asciinema-demo
branch
from
ee1f601 to
59e50f0
Compare
- Revert to CronJob example to maintain consistency with existing demos - Make generate-demo.sh flexible to support multiple demo variations - Add support for custom demo names and scripts via CLI parameters - Only update README for default kb-demo, not custom demos - Add usage/help documentation for the script This addresses feedback from camilamacedo86 on PR kubernetes-sigs#5068: 1. Keep the same example (CronJob instead of Guestbook/Busybox) 2. Allow script to generate other demos for future extensibility
wazery
force-pushed
the
w-asciinema-demo
branch
2 times, most recently
from
e9a06b1 to
b3ee602
Compare
|
Here is an example recording:
|
wazery
force-pushed
the
w-asciinema-demo
branch
2 times, most recently
from
601ef2f to
ef3d7ed
Compare
wazery
force-pushed
the
w-asciinema-demo
branch
from
ef3d7ed to
f721a8a
Compare
| sed -i "s|docs/gif/kb-demo\.v[^)]*\.svg|docs/gif/kb-demo.${version}.svg|g" "${PROJECT_ROOT}/README.md" | ||
| fi | ||
|
|
||
| log "README.md updated with new demo file ✓" |
There was a problem hiding this comment.
Is the script really generec and allow us to create demos for any place/doc?
Or is it creating only for the README
3 participants
This is a PR to address the issue #4552 which enhances the current script that creates the
asciinemademo recording, by having a minimal makefile target that generates the new recording and updates the root readme file.I also added a minimal script that sets up a minimal demo kind cluster so we can deploy into.