Yaba is a simple CLI tool that helps you manage releases of your Github projects.
You need npm in order to run the project on your local environment.
To install CLI package globally:
npm i -g yaba-release-cliTo Update:
npm update -g yaba-release-cliTo uninstall:
npm uninstall -g yaba-release-cliGo to Personal Access Tokens page on Github and generate new token to enable yaba CLI to access your repos.
- Give your desired name to your personal access token with
Notesection. - Choosing
reposcope is enough to useyabaCLI tool.
Now, your personal access token is generated. Copy that token and define that one as an environment variable:
export GITHUB_ACCESS_TOKEN=generated_personal_access_tokenYou can define that env variable into ~/.bashrc, ~/.bash_profile or ~/.zshrc file, choose which one is suitable for you. After defining the env variable, open new terminal or simply run source ~/.zshrc(here again choose where you defined your env variable).
If the repository owner is another Github account or organisation, you can define that like below instead of passing the owner to the command in every run.
export GITHUB_REPO_OWNER=repository_ownerAlways -o or --owner has precedence over authenticated user. Presendence is like -o > GITHUB_REPO_OWNER > authenticated-user.
Run yaba with --help options:
➜ ~ yaba --help
Usage: yaba -o <owner> -r <repository> -t <tag> -n <release-name> -b <body> -d
<draft> -c
Options:
--help Show help [boolean]
--version Show version number [boolean]
-o, --owner The repository owner. [string]
-r, --repo The repository name. [string]
-t, --tag The name of the tag. [string]
-n, --release-name The name of the release. [string]
-b, --body Text describing the contents of the tag. If not provided,
the default changelog will be generated with the usage of
the difference of master and latest release. [string]
-d, --draft `true` or only using `-d` makes the release a draft.
[boolean]
-c, --changelog Shows only changelog without creating the release.
[boolean]You can run yaba from a git directory or any other directories which is not a git repo.
If you are in a git repo and if you want to prepare release for that repo, you don't need to specify the repo name with the command, it will automatically detects the current directory and if it is a git repository yaba will use it as repo for the command.
By default, if you don't specify -o, -t, -n and -b the command will prepare default values for them with the below pattern:
-o: authenticated_user
-t: prod_global_YYYYMMDD.1
-n: Global release YYYY-MM-DD
-b: Commits between last release and master/main branch
IMPORTANT NOTE: If you don't explicitly define the release as draft with
-d,yabawill directly create the release with given or pre-defined values.
You have to clone the repository to your local machine
git clone [email protected]:volkanto/yaba.gitGo to project folder
cd yabaBuild dependencies
npm installYou have to install globally in order to run your yaba command
npm install -g .You can create an issue if you find any problem or feel free to create a PR with a possible fix or any other feature. Also, you can create an issue if you have any idea that you think it will be nice if we have it.
- Volkan Tokmak - volkanto