https://github.com/arononak/github-actions-gnome-extension
Tool to Show Github Actions status on Gnome Desktop.
https://github.com/arononak/github-actions-gnome-extension
github github-actions github-api gnome gnome-extension gnome-shell-extension
Last synced: 1 day ago
JSON representation
Tool to Show Github Actions status on Gnome Desktop.
- Host: GitHub
- URL: https://github.com/arononak/github-actions-gnome-extension
- Owner: arononak
- License: gpl-3.0
- Created: 2023-05-08T20:53:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T12:51:03.000Z (over 1 year ago)
- Last Synced: 2024-08-28T14:10:02.450Z (over 1 year ago)
- Topics: github, github-actions, github-api, gnome, gnome-extension, gnome-shell-extension
- Language: JavaScript
- Homepage: https://extensions.gnome.org/extension/5973/github-actions/
- Size: 10.1 MB
- Stars: 70
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[
](https://extensions.gnome.org/extension/5973/github-actions/)
# GitHub Actions Gnome Extension 🧩
[](https://github.com/arononak/github-actions-gnome-extension/graphs/contributors)
Table of Contents
- [GitHub Actions Gnome Extension 🧩](#github-actions-gnome-extension-)
- [🏞 Preview](#-preview)
- [🔨 Installation](#-installation)
- [🖥️ Development](#️-development)
- [1. 📜️ Development **rules**](#1-️-development-rules)
- [2. 📥 Cloning and running](#2--cloning-and-running)
- [3. ⌨️ Makefile commands](#3-️-makefile-commands)
- [📝 License](#-license)
# [🏞 Preview](./docs/SCREENSHOTS.md)
| Default | Simple mode |
|:----------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------:|
|  |  |
# [🔨 Installation](https://github.com/cli/cli/blob/trunk/docs/install_linux.md)
| Steps | Commands |
|:---------------------|:----------------------------------------------|
| 🔒 Login | `gh auth login --scopes user,repo,workflow` |
| 🔓 Check scopes | `gh auth status` |
| 🔄 If any is missing | `gh auth refresh --scopes user,repo,workflow` |
# [🖥️ Development](./docs/TODO.md)
```mermaid
graph TD
utils.js---->extension_utils.js
utils.js---->github_service.js
utils.js---->prefs_utils.js
utils.js---->settings_repository.js
extension_utils.js--->widgets.js
settings_repository.js-->date_format_controller.js
date_format_controller.js-->status_bar_indicator.js
extension_utils.js-->extension_controller.js
extension_utils.js-->status_bar_indicator.js
extension_utils.js-->quick_settings_controller.js
extension_utils.js-->notification_controller.js
widgets.js-->extension_controller.js
widgets.js-->status_bar_indicator.js
widgets.js-->quick_settings_controller.js
widgets.js-->notification_controller.js
settings_repository.js-->extension_controller.js
local_cli_interface.js-->github_service.js
token_scopes.js-->github_service.js
file_controller.js-->cache_repository.js
cache_repository.js-->extension_repository.js
github_service.js-->extension_repository.js
extension_repository.js-->extension_controller.js
settings_repository.js-->quick_settings_controller.js
settings_repository.js-->notification_controller.js
settings_repository.js-->prefs_controller.js
version.js[version.js - Generated by makefile]-->prefs_controller.js
prefs_utils.js-->prefs_controller.js
prefs_controller.js-->prefs.js
status_bar_indicator.js-->extension.js
notification_controller.js-->extension.js
quick_settings_controller.js-->extension.js
extension_controller.js-->extension.js
extension.js-->EXTENSION((GNOME EXTENSION))
schemas/-->EXTENSION((GNOME EXTENSION))
assets/-->EXTENSION((GNOME EXTENSION))
metadata.json-->EXTENSION((GNOME EXTENSION))
stylesheet.css-->EXTENSION((GNOME EXTENSION))
prefs.js-->EXTENSION((GNOME EXTENSION))
subgraph "Settings"
version.js
prefs.js
prefs_controller.js
prefs_utils.js
end
subgraph "Github API"
token_scopes.js
local_cli_interface.js
github_service.js
end
subgraph "Core"
extension.js
extension_controller.js
quick_settings_controller.js
notification_controller.js
status_bar_indicator.js
settings_repository.js
widgets.js
extension_utils.js
extension_repository.js
date_format_controller.js
file_controller.js
cache_repository.js
end
```
## 1. 📜️ Development **rules**
This project was built using **Aron Flow** (fuck scrum).
| Before `git push` | Before deploy |
|:-----------------------------|:---------------------------------------------|
| ✏️ `make lint-fix` | 🏞 New screenshots |
| | 🦍 [TESTING STEPS](./docs/TESTING_STEPS.md) |
| | 🏷️ New tag & release |
## 2. 📥 Cloning and running
```bash
git clone https://github.com/arononak/github-actions-gnome-extension.git
cd github-actions-gnome-extension
make install && make run
```
if the extension fails to load in the window:
```bash
make install && make logout
make install && make logout
make logs
```
## 3. ⌨️ Makefile commands
| Steps | Commands |
|:---------------------------------------------------------------------|:------------------------------------------------------------------|
| ▶️ Starts a gnome session in a window | `make run` |
| ➡️ Copying the extension from the system | `make copy` |
| 🔎️ Starts code analysis | `make lint` |
| ✏️ Starts ESLint fixing | `make lint-fix` |
| 🔄 Compiles schemas | `make compile` |
| 🛠️ Builds gnome-extensions package | `make build` |
| 📦 Builds and installs on system, gnome restart required | `make install` |
| 📼️ Displays logs of the current Gnome session | `make logs` |
| 😴 logout | `make logout` |
# 📝 License
> [!NOTE]
> Copyright © 2024 Aron Onak. All rights reserved.
> Licensed under the [GPL-3](LICENSE) license.
> If you have any feedback, please contact me at arononak@gmail.com
> [!WARNING]
> The GitHub logo is a trademark of Microsoft.
> This extension is not affiliated, funded, or in any way associated with Microsoft and GitHub.