Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌱 updates to enable autogenerated demo, hosted out-of-tree #212

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

grokspawn
Copy link
Contributor

@grokspawn grokspawn commented Nov 16, 2023

This PR was originally just bringing the in-repo animated gif demo up-to-date w.r.t. API changes, as it had lagged behind.

Based on feedback, it's rejiggered to provide the functional basis for automating the demo and hosting the resulting file at asciicast.org.

There will need to be follow-on PRs for workflow automation and updating the readme with generated demos.

@grokspawn grokspawn requested a review from a team as a code owner November 16, 2023 02:55
Copy link

codecov bot commented Nov 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a7cd270) 39.58% compared to head (03eb16d) 39.58%.
Report is 2 commits behind head on main.

❗ Current head 03eb16d differs from pull request most recent head f9e21c7. Consider uploading reports for the commit f9e21c7 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #212   +/-   ##
=======================================
  Coverage   39.58%   39.58%           
=======================================
  Files           8        8           
  Lines         485      485           
=======================================
  Hits          192      192           
  Misses        272      272           
  Partials       21       21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ncdc
Copy link
Member

ncdc commented Nov 17, 2023

Do you think it would be worth it for the sake of the git repo size to delete the demo gif and replace it with a link to an asciicinema? It won't remove the sizes of the previous revisions of the git from the repo's history, but it would stop us from additional increases.

@everettraven
Copy link
Collaborator

I'm +1 for moving to asciinema linked demos. It looks like the asciinema rec command has a -c, --command flag that can be used to specify the process that should be recorded: https://asciinema.org/docs/usage

I'm sure we could implement some form of automated demo updates using that flag and a script that runs through the demo.

@grokspawn
Copy link
Contributor Author

Do you think it would be worth it for the sake of the git repo size to delete the demo gif and replace it with a link to an asciicinema? It won't remove the sizes of the previous revisions of the git from the repo's history, but it would stop us from additional increases.

The only reason that we don't do something like that is because we can't control the hygiene of the link. Maybe I'm overly concerned with the idea of having a stale link in an alpha release.

@ncdc
Copy link
Member

ncdc commented Nov 28, 2023

I'm not sure what you mean about link hygiene?

@grokspawn
Copy link
Contributor Author

What's the retention policy on asciinema.org? If we have a link to content there, how do we keep it from expiring?

@ncdc
Copy link
Member

ncdc commented Nov 28, 2023

I've never seen one expire. If one does, it's presumably for some old demo that's no longer up to date and/or relevant.

@grokspawn
Copy link
Contributor Author

From the upload output:

This installation of asciinema recorder hasn't been linked to any asciinema.org
account. All unclaimed recordings (from unknown installations like this one)
are automatically archived 7 days after upload.

If you want to preserve all recordings made on this machine, connect this
installation with asciinema.org account by opening the following link:

This imposes a requirement that there is an associated account for any updated demos, presumably associated with the repo/org. I'm checking to see if one exists, because I'd prefer to have a better bus factor.

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
@grokspawn grokspawn changed the title 🌱 kludged script update to demo 🌱 updates to enable autogenerated demo, hosted out-of-tree Nov 29, 2023
@grokspawn
Copy link
Contributor Author

@ncdc, @everettraven re-implemented this PR as a step toward automating demo generation. Please take another look.

hack/scripts/demo-script.sh Outdated Show resolved Hide resolved
hack/scripts/demo-script.sh Outdated Show resolved Hide resolved
hack/scripts/demo-script.sh Show resolved Hide resolved
hack/scripts/generate-asciidemo.sh Show resolved Hide resolved
Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
@everettraven everettraven added this pull request to the merge queue Nov 29, 2023
Merged via the queue into operator-framework:main with commit 10a0803 Nov 29, 2023
10 checks passed
@grokspawn grokspawn deleted the demo-update-http branch November 29, 2023 16:56
@everettraven everettraven added this to the v0.11.0 milestone Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants