Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (53 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

66 lines (53 loc) · 2.63 KB

kitty-scrollback.nvim

Running tests

kitty-scrollback.nvim uses plenary.nvim's plenary.tests_harness as its testing harness.

  • Execute tests from the command line (preferred)
make test # run all tests excluding tests intended for demos
make test-all # run all tests
make test-all-sequential # run all tests sequentially, this is useful for machines with limited resources
make test-demo # run all demo tests
make test-demo-main # run only the main demo tests shown on the README
make test-demo-config # run all demo configuration tests
  • Execute tests from Neovim
    • Run entire tests directory: 
      :PlenaryBustedDirectory tests
    • Run currently open file 
      :PlenaryBustedFile %

Generating demos and wiki content (requires MacOS)

Prereq

  • git clone git@github.com/mikesmithgh/kitty-scrollback.nvim.wiki.git
    • The wiki repo should be a the same level as kitty-scrollback.nvim

Instructions (TODO: move wiki scripts to main repo and add to Makefile)

  • cd kitty-scrollback.nvim
  • make record-demo
  • cd kitty-scrollback.nvim.wiki
  • ls -1 assets/*.mov | xargs -I {} scripts/mov_to_gif.sh {}
  • Upload all mov files in the assets directory to Github by dragging them to a markdown file in the browser
  • Copy all the generated embedded video urls and paste in uploaded_movs array in the make_video_markdown_files.sh script
  • ./scripts/make_video_markdown_files.sh
  • ./scripts/make_adv_config_markdown_file.lua &> Advanced-Configuration-Examples.md

Troubleshooting

Github Actions

Interactive debugging

  • Run the workflow tests
    • Check enable_debug_vnc to enable TurboVNC, ngrok, and tmate debugging
      • This allows you to connect to the Github runner via vnc (for GUI) and ssh
      • Troubleshooting:
        • If the Github runner timers out and requires a login, you can ssh into the tmate session and restart VNC.
        export PATH="/opt/TurboVNC/bin:$PATH"
vncserver -kill :1
vncserver -geometry 2560x1080 -SecurityTypes None
    • Check enable_debug_tmate to enable tmate debugging
      • This allows you to connect to the Github runner via ssh

Verbose logging

  • Enable verbose logging by running the action with debug logging enabled.
    • This can also be achieved by setting RUNNER_DEBUG to 1, RUNNER_DEBUG=1 make test