Skip to content

DanBradbury/github-actions.vim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Actions for Vim

github-actions.vim provides a convenient way to view and interact with GitHub Actions directly in vim.

github-actions-v1.0.0.mov

Requirements

  • Vim 9.0+
  • The gh CLI tool must be installed and authenticated. You can install it from GitHub CLI.

Features

  • Lists GitHub Actions workflows for the current repository.
  • Allows you to open workflow details in your default browser.
  • Toggle the GitHub Actions sidebar on and off.

Usage

Commands

  • :GithubActions Opens/toggles the GitHub Actions popup

Popup Keybindings

  • Number keys Open workflow listed with the given number
  • Enter on a workflow line to open the workflow in your default browser.
  • Backspace Go back to previous page content
  • o Open whats under the cursor in GitHub (Workflow, Workflow run)
  • w Open workflow file in the last active buffer

Configuration

You can customize the behavior of the plugin using the following global variables:

g:github_actions_window_side

Specifies the side of the window where the GitHub Actions sidebar will open. Possible values: 'left' (default) or 'right'.

Example:

let g:github_actions_window_side = 'right'

g:github_actions_window_size

Specifies the width of the GitHub Actions sidebar buffer. Default: 50.

Example:

let g:github_actions_window_size = 40

Troubleshooting

  • Error: Unable to fetch workflows. Ensure the gh CLI is authenticated. Ensure that the gh CLI is installed and authenticated with your GitHub account.

  • Not a GitHub repository The plugin only works in directories that are Git repositories hosted on GitHub.


License

This plugin is open-source and available under the MIT License.


Enjoy using github-actions.vim! 🎉

About

Interact with GitHub Actions in vim

Topics

Resources

License

Contributing

Stars

Watchers

Forks