{"id":13751842,"url":"https://github.com/paulononaka/bitactions","last_synced_at":"2025-05-09T18:32:27.386Z","repository":{"id":140434638,"uuid":"303549739","full_name":"paulononaka/bitactions","owner":"paulononaka","description":"🟢 A plugin for xBar that displays Github Actions status in your Mac OS X Menu Bar","archived":false,"fork":false,"pushed_at":"2023-07-28T17:20:07.000Z","size":1234,"stargazers_count":32,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-03T09:03:19.330Z","etag":null,"topics":["bitbar","cd","ci","ci-cd","github-actions","radiator","xbar"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paulononaka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-13T00:55:20.000Z","updated_at":"2024-05-24T05:05:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"283bd5c7-9744-4d2e-a85c-d9029b0992b5","html_url":"https://github.com/paulononaka/bitactions","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulononaka%2Fbitactions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulononaka%2Fbitactions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulononaka%2Fbitactions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulononaka%2Fbitactions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paulononaka","download_url":"https://codeload.github.com/paulononaka/bitactions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224876976,"owners_count":17384699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitbar","cd","ci","ci-cd","github-actions","radiator","xbar"],"created_at":"2024-08-03T09:00:55.664Z","updated_at":"2024-11-16T04:31:46.982Z","avatar_url":"https://github.com/paulononaka.png","language":"JavaScript","funding_links":[],"categories":["Developer Utilities"],"sub_categories":["Git \u0026 GitHub"],"readme":"# BitActions - Github Actions status for a specific Github repository on macOS menu bar\n\nInspired by [Hukum](https://github.com/abskmj/hukum) BitActions is a BitBar plugin that displays Github Actions status for a specific Github repository in your Mac OS X Menu Bar.\nIt is good for watching a regular Github workflow setup from your project, but also to allow you to filter a specific branch that you are working on in a pull request workflow.\n\n## Example\n\n![BitActions example showing GitHub Actions status on macOS menu](images/sample.png)\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org/)\n- [XBar](https://xbarapp.com/)\n- Open xbar\n\n## Installation\n\nMake sure you have `node` and `npm`, then run:\n```sh\ncurl https://raw.githubusercontent.com/paulononaka/bitactions/master/install.sh | bash\n```\n\n## Configuration\n\nCreate a `.bitactionsrc` file in your $HOME with the following content:\n\n```json\n{\n    \"githubToken\": \"\u003cYour personal classic Git hub token. Ex: aaa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\u003e\",\n    \"githubRepoName\": \"\u003cYou can get it from the end of the GithHub URL of the project you want to watch. Ex: acme_corporation/my_project\u003e\",\n    \"localRepoPath\": \"\u003cFull path of your repo in your local machine. This will serve to automatically watch the branch you are. Ex: /Users/paulononaka/codes/my_project\u003e\",\n    \"watchBranchName\": \"\u003cBranch name to watch when local branch does not have any runs on GitHub. Ex: main\u003e\",\n    \"statusMode\": \"\u003cbranch OR summary OR rotate. Ex: branch\u003e\"\n}\n```\n\nAfter the configuration, click on xbar your on Mac OS bar and refresh it. Wait a few seconds for the first Github request and voalá. The plugin should starts working.\n\n## githubToken\n// **Optional** for public repos, required for privated ones - Your personal classic Git hub token. A forty-digit alphanumeric string.\n\nTLTR: Follow these steps at [docs.github.com](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) to create a personal token (classic).\n\nBitActions 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)). Authenticated requests have higher limits, up to 5000 requests per hour.\n\nThe 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.\n\n## githubRepoName\n// **Required** - Github repo name. Ex: acme_corporation/my_project\n\nYou can get it from the end of the GithHub URL of the project you want to watch.\nEx: `https://github.com/acme_corporation/my_project` becomes `acme_corporation/my_project`.\n\n## localRepoPath\n// **optional** - Ex: /Users/paulononaka/codes/my_project\n\nSay you have a workflow that triggers `on: pull_request`. GitHub Actions keeps one workflow for all pushed branches so the last run might not be the branch that you are working on locally, the one you really want to monitor.\n\nGiven that, set this option if you wish to watch specifics branches you are working on locally. If you set it, a submenu with the workflow will monitor this branch. If you wish the status also appears in the main Mac OS menu bar, set `statusMode` to `branch`.\n\nPlease notice that this feature uses the local branch from a local repo, so if you change the branch locally the submenu will attempt to search for that branch and if it isn't pushed yet (has no runs) it won't be displayed.\n\n## watchBranchName\n// **required** - Ex: main\n\nThis will be the monitored branch if you set `statusMode` to `branch`, but your local branch has no runs yet.\n\n## statusMode\n// **Optional** - branch, rotate or summary. Ex: summary\n\nChoose how the macOS menu bar should appear in the macOS bar menu:\n\n- summary - Shows all workflows at once, without workflows names.\n\n![summary](images/summary.png)\n\n- rotate - Rotates the workflow with its name, showing one at a time.\n\n![rotate](images/rotate.gif)\n\n- branch - Fixes the status to the branch you are working on your `localRepoPath`.\n\n![branch](images/branch.png)\n\n##\n\n# How it works?\nBitActions 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 time your Xbar refreshes.\n\n# Contributing\n\nContribution with code or documentation by raising a [pull request](https://github.com/paulononaka/bitactions/pulls) are more than welcome! Head over to the [issues tab](https://github.com/paulononaka/bitactions/issues) to report any bug or suggest an improvement. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulononaka%2Fbitactions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulononaka%2Fbitactions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulononaka%2Fbitactions/lists"}