README
¶
gh-dxp
A GitHub (gh) CLI extension for automating daily development work, brought to you by Elhub's DevXP team. It implements an opinionated workflow based around small and frequent commits, squash merge, and mandatory linting and unit testing. To view more detailed documentation, please refer to the gh-dxp page in docs-support.
User Guide
Using the -h flag with any command will display relevant documentation.
In addition to that, a user guide for gh dxp can be found here
Aliases
To avoid having to type gh dxp constantly, we recommend running:
gh alias import alias.yml
On the alias.yml file that follows this project. This installs a number of useful aliases for the commands in this extension.
Installation
- Install the
ghCLI - Install gh-dxp:
gh extension install elhub/gh-dxp
Install from source
If you want to install this extension from source, such as for development, follow these two steps:
-
Clone the repo
# git git clone https://github.com/elhub/gh-dxp -
Build and install locally
cd gh-dxp; make clean install
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
branch
Package branch provides functions to work with git branches.
|
Package branch provides functions to work with git branches. |
|
cmd
Package cmd provides the main commands for the gh-dxp extension.
|
Package cmd provides the main commands for the gh-dxp extension. |
|
config
Package config provides the logic for reading the configuration settings from a file.
|
Package config provides the logic for reading the configuration settings from a file. |
|
lint
Package lint provides functions to run linting on the codebase.
|
Package lint provides functions to run linting on the codebase. |
|
owner
Package owner provides the functionality to get the codeowners of a given path
|
Package owner provides the functionality to get the codeowners of a given path |
|
pr
Package pr contains the functions and types for the pull request command.
|
Package pr contains the functions and types for the pull request command. |
|
template
Package template provides utilities to set up new repositories using our project template.
|
Package template provides utilities to set up new repositories using our project template. |
|
utils
Package utils provides common utilities for the gh-dxp extension.
|
Package utils provides common utilities for the gh-dxp extension. |