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

docs: Add Logging example README #157

Merged
merged 1 commit into from
Nov 4, 2021
Merged

Conversation

btlghrants
Copy link
Contributor

closes #131

@jeff-mccoy
Copy link
Contributor

quick ?, the asciicinema (sp?) shown is run via the expect script?

@btlghrants
Copy link
Contributor Author

btlghrants commented Nov 4, 2021

quick ?, the asciicinema (sp?) shown is run via the expect script?

Pretty much all of the logic for making recordings is held in there but that's not the thing that gets called initially, because:

  • the expect scripts require certain tools/software to be installed (as in the runner VM @ docs/asciinema/Vagrantfile) (e.g. jq)
  • the expect scripts aren't called directly; they're invoked by & require some args to be passed-in from the docs/asciinema/asciinema.sh "wrapper" script
  • Most of the terminal settings, text coloring & waiting, along with the actual asciinema recording is done from inside the docs/asciinema/scenarios/*.exp scripts.

So, making a new recording (a.k.a. "running a scenario") actually gets kicked off by running a command like this (from within the asciinema VM):

cd <blah/blah/docs/asciinema>
./asciinema.sh run scenarios/examples-game-logging.exp

@jeff-mccoy
Copy link
Contributor

/test all

@jeff-mccoy jeff-mccoy merged commit fab8dc8 into master Nov 4, 2021
@jeff-mccoy jeff-mccoy deleted the docs/131-add-logging branch November 4, 2021 20:18
jeff-mccoy pushed a commit that referenced this pull request Feb 8, 2022
Signed-off-by: Jeff McCoy <code@jeffm.us>
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
Signed-off-by: Jeff McCoy <code@jeffm.us>
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.

Main README: Coming Soon - Add Logging
2 participants