Skip to content

Commit 3c98e7e

Browse files
committed
docs(readme): document compact mode and add screenshot
- Generate a formatted changelog in the release workflow, grouping changes by type. - Enhance release description with features, configuration, and installation details. - Document "Compact Mode" in the README and add a new screenshot (`compact_clipse-gui.png`).
1 parent 642f703 commit 3c98e7e

4 files changed

Lines changed: 13 additions & 87 deletions

File tree

.github/workflows/release.yml

Lines changed: 3 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,17 @@ jobs:
2727
2828
if [ -z "$PREV_TAG" ]; then
2929
# If no previous tag, get all commits
30-
CHANGELOG=$(git log --pretty=format:"- %s (%h)" ${{ github.ref }})
30+
CHANGELOG=$(git log --pretty=format:"- %s" ${{ github.ref }})
3131
else
3232
# Get commits between previous tag and current tag
33-
CHANGELOG=$(git log --pretty=format:"- %s (%h)" $PREV_TAG..${{ github.ref }})
33+
CHANGELOG=$(git log --pretty=format:"- %s" $PREV_TAG..${{ github.ref }})
3434
fi
3535
3636
# Clean up the changelog
3737
CHANGELOG=$(echo "$CHANGELOG" | grep -v "chore:" | grep -v "ci:" | grep -v "docs:")
3838
39-
# Group changes by type
40-
FEATURES=$(echo "$CHANGELOG" | grep -i "feat:" | sed 's/feat: //')
41-
FIXES=$(echo "$CHANGELOG" | grep -i "fix:" | sed 's/fix: //')
42-
IMPROVEMENTS=$(echo "$CHANGELOG" | grep -i "improve:" | sed 's/improve: //')
43-
REFACTOR=$(echo "$CHANGELOG" | grep -i "refactor:" | sed 's/refactor: //')
44-
45-
# Create formatted changelog
46-
cat > changelog.md << EOF
47-
## 🚀 New Features
48-
$FEATURES
49-
50-
## 🐛 Bug Fixes
51-
$FIXES
52-
53-
## ⚡ Improvements
54-
$IMPROVEMENTS
55-
56-
## 🔧 Refactoring
57-
$REFACTOR
58-
EOF
59-
6039
echo "changelog<<EOF" >> $GITHUB_OUTPUT
61-
cat changelog.md >> $GITHUB_OUTPUT
40+
echo "$CHANGELOG" >> $GITHUB_OUTPUT
6241
echo "EOF" >> $GITHUB_OUTPUT
6342
6443
- name: Generate release description
@@ -85,7 +64,6 @@ jobs:
8564
### 🎨 UI/UX
8665
- 🎯 Compact mode for minimal footprint
8766
- 🔄 Real-time updates
88-
- 🎯 Mouse-following window positioning
8967
- 📱 Responsive and adaptive layout
9068
9169
### ⚡ Performance
@@ -101,13 +79,6 @@ jobs:
10179
## 🔧 Configuration
10280
Configuration file: \`~/.config/clipse-gui/settings.ini\`
10381
104-
### Key Settings
105-
- \`compact_mode\`: Enable minimal UI mode
106-
- \`enter_to_paste\`: Auto-paste after selection
107-
- \`save_debounce_ms\`: Save delay after changes
108-
- \`search_debounce_ms\`: Search filter delay
109-
- \`paste_simulation_delay_ms\`: Paste delay
110-
11182
## 📝 Changelog
11283
${{ steps.changelog.outputs.changelog }}
11384
@@ -132,56 +103,3 @@ jobs:
132103
generate_release_notes: true
133104
draft: false
134105
prerelease: false
135-
136-
update-aur:
137-
runs-on: ubuntu-latest
138-
environment: main
139-
needs: release
140-
steps:
141-
- name: Checkout code
142-
uses: actions/checkout@v4
143-
144-
- name: Extract version
145-
id: get_version
146-
run: echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
147-
148-
- name: Set up Git
149-
run: |
150-
git config --global user.name "GitHub Actions"
151-
git config --global user.email "actions@github.com"
152-
153-
- name: Set up SSH
154-
env:
155-
AUR_SSH_KEY: ${{ secrets.AUR_SSH_KEY }}
156-
run: |
157-
mkdir -p ~/.ssh
158-
echo "$AUR_SSH_KEY" > ~/.ssh/id_rsa
159-
chmod 600 ~/.ssh/id_rsa
160-
ssh-keyscan -t rsa aur.archlinux.org >> ~/.ssh/known_hosts
161-
162-
- name: Clone AUR repo
163-
run: |
164-
git clone ssh://aur@aur.archlinux.org/clipse-gui.git aur-repo
165-
166-
- name: Update PKGBUILD
167-
run: |
168-
cd aur-repo
169-
git config --global --add safe.directory "$(pwd)"
170-
sed -i "s/^pkgver=.*/pkgver=${{ steps.get_version.outputs.version }}/" PKGBUILD
171-
sed -i "s/^pkgrel=.*/pkgrel=1/" PKGBUILD
172-
173-
- name: Setup Arch environment for AUR operations
174-
run: |
175-
sudo pacman -Syu --noconfirm
176-
sudo pacman -S --noconfirm base-devel
177-
cd aur-repo
178-
updpkgsums
179-
makepkg --printsrcinfo > .SRCINFO
180-
ls -la
181-
182-
- name: Commit and push AUR update
183-
run: |
184-
cd aur-repo
185-
git add PKGBUILD .SRCINFO
186-
git commit -m "Update to v${{ steps.get_version.outputs.version }}"
187-
git push

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ This GUI provides a visual way to browse, search, pin, preview, and copy items f
66

77
![Clipse GUI Screenshot](docs/screenshot.png)
88

9+
10+
<details>
11+
<summary>Table of Contents</summary>
12+
13+
![compact_clipse-gui.png](docs/compact_clipse-gui.png)jkk
14+
<details>
15+
916
## Table of Contents
1017

1118
- [Features](#features)
@@ -22,6 +29,7 @@ This GUI provides a visual way to browse, search, pin, preview, and copy items f
2229
- **Pinning:** Mark important items as "pinned" to keep them visible or filter by them.
2330
- **Preview:** View full text content or larger image previews in a separate window.
2431
- **Copy:** Copy any item from the history back to the system clipboard.
32+
- **Compact Mode:** Minimal UI mode with reduced padding and hidden search bar until needed.
2533
- **Paste on Enter (Optional):** Configure the application to automatically simulate a paste (Ctrl+V) into the previously focused application after selecting an item with Enter. Requires helper tools (`wtype` for Wayland, `xdotool` for X11).
2634
- **Wayland & X11 Support:** Uses configurable external tools for clipboard interaction, supporting both display server protocols.
2735
- **Lazy Loading:** Loads history items incrementally for better performance with large history files.
@@ -136,7 +144,7 @@ The configuration file uses the standard INI format, divided into sections (`[Se
136144
| `clipse_dir` | String | `~/.config/clipse` | Path to the directory containing the clipboard history file. `~` is expanded to your home directory. |
137145
| `history_filename` | String | `clipboard_history.json` | Name of the JSON file containing the clipboard history within `clipse_dir`. |
138146
| `enter_to_paste` | Boolean | `False` | If `True`, pressing Enter will copy the item _and_ attempt to simulate a paste (e.g., Ctrl+V). Requires `wtype` (Wayland) or `xdotool` (X11). |
139-
| `compact_mode` | Boolean | `False` | _(Currently unused, placeholder for future UI variant)_ |
147+
| `compact_mode` | Boolean | `False` | If `True`, enables minimal UI mode with reduced padding and hidden search bar until needed. |
140148
| `save_debounce_ms` | Integer | `300` | Delay (in milliseconds) after pinning/deleting an item before the history file is saved to disk. |
141149
| `search_debounce_ms` | Integer | `250` | Delay (in milliseconds) after typing in the search bar before the list is filtered. |
142150
| `paste_simulation_delay_ms` | Integer | `150` | Delay (in milliseconds) after hiding the Clipse GUI window before the paste simulation (if enabled) is triggered. Allows focus to return to the previous window. |

clipse_gui/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.1.2"
1+
__version__ = "0.1.4"

docs/compact_clipse-gui.png

31.4 KB
Loading

0 commit comments

Comments
 (0)