Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/actions.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ version: 'v0.0.3'
workflows:
'.github/workflows/ci.yml':
- 'actions/checkout@v7.0.1'
- 'actions/setup-node@v7.1.0'
- 'actions/upload-artifact@v7.0.2'
- 'pnpm/setup@v3.1.2'
'.github/workflows/renovate.yml': []
dependencies:
'actions/checkout@v7.0.1':
ref: 'v7.0.1'
commit: 'sha1-3d3c42e5aac5ba805825da76410c181273ba90b1'
owner_id: 44036562
repo_id: 197814629
'actions/setup-node@v7.1.0':
ref: 'v7.1.0'
commit: 'sha1-949feb2413d6458794dcd2491c4babbbce0c15c1'
owner_id: 44036562
repo_id: 189476904
'actions/upload-artifact@v7.0.2':
ref: 'v7.0.2'
commit: 'sha1-cf430e030ddbb5b0abf93d22962f4752f3646cd9'
owner_id: 44036562
repo_id: 192625955
'pnpm/setup@v3.1.2':
ref: 'v3.1.2'
commit: 'sha1-fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e'
owner_id: 21320719
repo_id: 1235693694
8 changes: 5 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,19 @@
- uses: actions/checkout@v7.0.1
with:
persist-credentials: false
- uses: actions/setup-node@v7.1.0
- uses: pnpm/setup@v3.1.2

Check failure on line 20 in .github/workflows/ci.yml

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Use full commit SHA hash for this dependency.

See more on https://sonarcloud.io/project/issues?id=gitify-app_kde&issues=AaGcxW5PDOPEoOForJT7&open=AaGcxW5PDOPEoOForJT7&pullRequest=30
with:
node-version-file: .nvmrc
cache: true
require-lockfile: true
- name: Check syntax and placement behavior
run: |
node --check gitify/contents/code/main.js
bash -n scripts/install.sh scripts/bundle.sh
python3 -m py_compile scripts/test-live.py
npm test
pnpm test
- name: Bundle KWin script
run: npm run bundle
run: pnpm bundle
- uses: actions/upload-artifact@v7.0.2
with:
name: gitify-kwin-script
Expand Down
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,20 @@ it does and how to install it, and [Gitify][gitify-repo] for the app itself.

## 🛠️ Development

Install dependencies (Node version from `.nvmrc`):

```sh
pnpm install
```

```sh
npm test
npm run bundle
pnpm test
pnpm bundle
```

Tests run the same script in a JavaScript VM with compositor events and cover panel placement, display boundaries, resizing, repeated opens, and window filtering.

With Gitify installed, run `npm run test:live` inside a Plasma Wayland session. This needs Node 24, Python 3, and PyGObject, provided by `python-gobject` on Arch. It launches Gitify with a temporary profile, measures the window through KWin, and checks placement, resizing, and tray hide/reopen. It tests the installed script if enabled; otherwise, it temporarily loads this checkout's script. It unloads its temporary script and closes the test app when finished.
With Gitify installed, run `pnpm test:live` inside a Plasma Wayland session. This needs Node (see `.nvmrc`), plus system Python 3 and PyGObject, provided by `python-gobject` on Arch. Python is intentionally system-managed because the live test imports the distro's PyGObject. It launches Gitify with a temporary profile, measures the window through KWin, and checks placement, resizing, and tray hide/reopen. It tests the installed script if enabled; otherwise, it temporarily loads this checkout's script. It unloads its temporary script and closes the test app when finished.

Building the `.kwinscript` bundle requires Python 3. The bundle contains only the metadata and JavaScript; users do not need Node or Python to run the installed script.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The installer uses `kpackagetool6`, `kwriteconfig6`, and `qdbus6`. It installs f

To update, run `git pull --ff-only` in this checkout and rerun `bash scripts/install.sh`.

Alternatively, build the bundle with `npm run bundle`, which needs Node 24 or newer and Python 3. Import `dist/gitify.kwinscript` through **System Settings → Window Management → KWin Scripts → Install from File**, then enable Gitify and apply.
Alternatively, build the bundle with `pnpm bundle`. The Node version is pinned in `.nvmrc`; Python 3 is provided by your system. Import `dist/gitify.kwinscript` through **System Settings → Window Management → KWin Scripts → Install from File**, then enable Gitify and apply.

### ✅ Check that it works

Expand Down
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
"name": "node",
"version": "26.13.0",
"onFail": "warn"
},
"packageManager": {
"name": "pnpm",
"version": "12.16.1",
"onFail": "download"
}
},
"engines": { "node": ">=24" }
Expand Down
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading