Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elhub/gh-dxp
GitHub CLI extension implementing an opinionated workflow for branches, commits, and pull requests.
https://github.com/elhub/gh-dxp
automation gh-extension git git-branching productivity pull-request
Last synced: 3 months ago
JSON representation
GitHub CLI extension implementing an opinionated workflow for branches, commits, and pull requests.
- Host: GitHub
- URL: https://github.com/elhub/gh-dxp
- Owner: elhub
- License: mit
- Created: 2024-01-25T16:35:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T16:38:00.000Z (6 months ago)
- Last Synced: 2024-05-16T17:47:53.589Z (6 months ago)
- Topics: automation, gh-extension, git, git-branching, productivity, pull-request
- Language: Go
- Homepage:
- Size: 86.9 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
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 under docs-support.
### Aliases
To avoid having to type `gh dxp` constantly, we recommend running:
```sh
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
1. [Install the `gh` CLI](https://github.com/cli/cli#installation)
2. Install gh-dxp:
```sh
gh extension install elhub/gh-dxp
```
Install from source
If you want to install this extension **from source**, such as for development, follow these steps:
1. Clone the repo
```bash
# git
git clone https://github.com/elhub/gh-dxp
```
2. Build and install locally
```bash
cd gh-dxp; make clean install
```
## RoadMap
Following are some of the things we are thinking/working on.
* Wish-List:
* Proper Jira integration. Do some basic Jira checks (is ticket assigned, put into progress, etc).