https://github.com/funkymed/homebrew-fteam
A tool to display in cli the current status, progress, and celerity of the team.
https://github.com/funkymed/homebrew-fteam
cli gitlab hombrew-tap homebrew homebrew-formula shell
Last synced: 4 months ago
JSON representation
A tool to display in cli the current status, progress, and celerity of the team.
- Host: GitHub
- URL: https://github.com/funkymed/homebrew-fteam
- Owner: funkymed
- Created: 2021-09-01T15:14:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-02T20:49:28.000Z (almost 5 years ago)
- Last Synced: 2025-01-07T21:26:22.798Z (over 1 year ago)
- Topics: cli, gitlab, hombrew-tap, homebrew, homebrew-formula, shell
- Language: Ruby
- Homepage: https://medium.com/@cyrilgeorgespereira/how-to-manage-celerities-in-a-sprint-with-feature-team-965953d19e7f
- Size: 1.77 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Feature-Team management tool for Gitlab
This [Homebrew](https://brew.sh) tap makes it simpler to install ggshield on Homebrew supported platforms.
A tool to display in cli the current status, progress, and celerity of the team.
## Gitlab
#### Milestone
You will have to add a milestone on every issues.
#### Weight
**If you have a Gitlab Premium** : you can use the weight.
**If you don't** : just add in your issue description at the end `Weight : x` replace x by the weight you want, the application will do the rest.
You're welcome ;)
## Installation
```bash
$ brew tap funkymed/fteam
$ brew install fteam
```
### Configuration
Create a file `.env` in your home directory `~/.fteam`
Edit the credential and configuration for your gitlab
```bash
###> gitlab ###
GITLAB_TOKEN=xxx
GITLAB_ID=123
GITLAB_PATH=xxx
GITLAB_URL=https://gitlab.com
GITLAB_DEBUG=false
GITLAB_LABELS=my-feature-team
GITLAB_WORKFLOW_BACKLOG=backlog
GITLAB_WORKFLOW_WIP=doing,review
GITLAB_WORKFLOW_BLOCKED=blocked
GITLAB_WORKFLOW_REJECTED=rejected
GITLAB_WORKFLOW_ACCEPTED=to_merged,merged
GITLAB_WORKFLOW_FINISHED=merged
###< gitlab ###
```
### Customize Workflow
- `GITLAB_WORKFLOW_BACKLOG` : the backlog label
- `GITLAB_WORKFLOW_WIP` : the labels in progress, separate with coma (start, in review, ...)
- `GITLAB_WORKFLOW_BLOCKED` : the blocked issues label
- `GITLAB_WORKFLOW_REJECTED` : the rejected issues label
- `GITLAB_WORKFLOW_ACCEPTED` : the labels in progress, separate with coma (merged, accepted, ...)
## How to use
### Get board and celerity from a milestone
```bash
./bin/console celerity:milestone --milestone="sprint-2021-W21-23"
```
#### Display all the peoples stats from a milestone
```bash
$ ./bin/console celerity:milestone
Select the milestone
[0 ] sprint-2021-W23-25
[1 ] sprint-2021-W21-23
[2 ] sprint-2021-W19-W21
[3 ] sprint-2021-W17-W20
[4 ] sprint-2021-W15-W17
[5 ] sprint-2021-W13-W15
[6 ] sprint-2021-W11-W13
[7 ] sprint-2021-W9-W11
[8 ] sprint-2021-W7-W9
[9 ] sprint-2021-W5-W7
[10] sprint-2021-W3-W5
[11] sprint-2021-W1-W3
[12] sprint-2020-W53-W55
[13] sprint-2020-W51-W53
```
#### options
- `--epics`: display the epics of the milestone (optional)
- `--epics_detail`: display the epics with more detail of the milestone (optional)
- `--label` : display issue with the specifique label (optional)
- `--markdown` : display the table in markdown
- `--snapshot` : display a table simplifiy version in markdown of the board
```bash
./bin/console celerity:milestone --milestone="sprint-2021-W21-23"
```
```bash
./bin/console celerity:milestone --milestone="sprint-2021-W21-23" --epics --label="team::back" --label="team::front"
```
```bash
./bin/console celerity:milestone --milestone="sprint-2021-W21-23" --epics --label="team::devops"
```
### Display all the issues of a milestone by people
```bash
./bin/console celerity:issue --milestone="sprint-2021-W21-23"
```
#### Options :
- `--with-weight` : display issue with weight (optional)
- `--without-weight` : display issue without weight (optional)
- `--not-assigned` : display issue not assigned (optional)
- `--assigned` : display issue assigned (optional)
- `--label` : display issue with the specifique label (optional)
- `--state` : Specify the state (backlog|started|review|staging|blocked|rejected|preprod|closed) (optional)
```bash
$ ./bin/console celerity:issue --milestone="sprint-2021-W21-23" --without-weight --state="closed" --label="team::back" --label="team::front"
```
### Display celerity by user from selected milestones.
```bash
./bin/console celerity:celerity --milestone="sprint-2021-W21-23" --milestone="sprint-2021-W23-25" --milestone="sprint-W25-W27" --label="team::back"
```
#### Options :
- `--milestone` : set the milestones you want to browse for celerity (optional)
- `--label` : set the labels you want to browse for celerity (optional)