Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abskmj/hukum
An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime.
https://github.com/abskmj/hukum
developer-experience developer-productivity developer-tools github-actions github-api javascript npm npm-module
Last synced: 29 days ago
JSON representation
An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime.
- Host: GitHub
- URL: https://github.com/abskmj/hukum
- Owner: abskmj
- License: mit
- Created: 2020-06-30T11:56:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T11:13:01.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T08:18:41.868Z (about 1 month ago)
- Topics: developer-experience, developer-productivity, developer-tools, github-actions, github-api, javascript, npm, npm-module
- Language: JavaScript
- Homepage: https://npmjs.com/package/hukum
- Size: 688 KB
- Stars: 403
- Watchers: 5
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - abskmj/hukum - An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime. (JavaScript)
README
   [](https://github.com/abskmj/hukum)
# Hukum - Displays Github Action progress in terminal
Hukum is an NPM module that displays Github Action (GA) progress in the terminal. It works for workflows that run when a commit is pushed to Github repo. Once a commit is pushed, Hukum will print status updates in realtime.
Hukum aims to improve your development experience with immediate feedback of the GA Workflow in your terminal.
# Installation
```bash
npm install --global hukum
hukum
```
# How it works?
Hukum uses [Github Actions API](https://docs.github.com/en/rest/reference/actions) to get the related workflow to the recent git push and its status. It keeps on calling the APIs every 1 second to update the status on the terminal.
Below is a sample output for one of the workflows.
```
Add post - Setup Snapcraft in a Github Action Workflow
✔ deploy 16s
✔ Set up job 2s
✔ Run actions/checkout@v2 0s
✔ Install hugo 8s
✔ Install hugo theme 1s
✔ Build 0s
✔ Deploy 5s
✔ Post Run actions/checkout@v2 0s
✔ Complete job 0s
```
# Configuration
Hukum can work out of the box without any configuration. However, it provides a few configuration options. Include a `.hukumrc` file in your home directory or the root of the project with the following contents or set the below environment variables.
```json
{
"github": {
"token": ""
}
}
```
## Github Personal token
```js
// .hukumrc
{ "github": { "token": "" } }
```
```bash
# environment variable
HUKUM_GITHUB_TOKEN=
```
Hukum uses [Github Actions API](https://docs.github.com/en/rest/reference/actions). It is possible to use these APIs without any authentication for public repositories. However, for unauthenticated requests, the rate limit allows for up to 60 requests per hour (Details at [docs.github.com](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)) which can exhaust quickly. Authenticated requests have higher limits, up to 5000 requests per hour.
You can follow these steps at [docs.github.com](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to create a personal token. The token does not need to have any specific scope for public repositories. However, the token needs to have `repo - Full control of private repositories` scope for private repositories.
# Fixes & Improvements
Head over to the issues tab at [github.com](https://github.com/abskmj/hukum/issues) to report a bug or suggest an improvement. Feel free to contribute to the code or documentation by raising a pull request.
# Sponsor / Support
If you find the project interesting or helpful, please consider sponsoring or supporting it at [github.com](https://github.com/abskmj/hukum).
# Links
- [NPM Repository](https://www.npmjs.com/package/hukum)
- [Changelog](https://github.com/abskmj/hukum/releases)
- [Report an issue](https://github.com/abskmj/hukum/issues)
- [Source Code](https://github.com/abskmj/hukum)
- [License](https://github.com/abskmj/hukum/blob/master/LICENSE)
- [Sponsor](https://github.com/abskmj/hukum)