Skip to content

Commit 040d3dc

Browse files
bivlkedclaude
andcommitted
chore: add CI workflow, profiles section, and PSGallery metadata
- Add GitHub Actions CI with PSScriptAnalyzer linting - Add Recommended Profiles section to README (EN/RU) - Add CI badge to both READMEs - Add Success Story issue template for user feedback - Add PSScriptInfo block for PowerShell Gallery publication Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent b8649a1 commit 040d3dc

5 files changed

Lines changed: 164 additions & 0 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Success Story / История успеха
3+
about: Share your experience with WinClean / Поделитесь опытом использования
4+
title: '[SUCCESS] '
5+
labels: success-story
6+
assignees: ''
7+
---
8+
9+
## Your Results / Ваши результаты
10+
11+
**Space freed / Освобождено места:** [e.g., 15 GB]
12+
13+
**Profile used / Использованный профиль:**
14+
- [ ] Full (default)
15+
- [ ] Safe (`-SkipUpdates -SkipDockerCleanup`)
16+
- [ ] Developer
17+
- [ ] Custom (describe below)
18+
19+
## Environment / Окружение
20+
21+
- **Windows Version**: [e.g., Windows 11 23H2]
22+
- **PowerShell Version**: [e.g., 7.4.1]
23+
- **System type**: [e.g., Developer workstation, Gaming PC, etc.]
24+
25+
## What was cleaned / Что было очищено
26+
27+
Which categories freed the most space for you?
28+
Какие категории освободили больше всего места?
29+
30+
- [ ] Temp files
31+
- [ ] Browser caches
32+
- [ ] Developer caches (npm, pip, nuget, etc.)
33+
- [ ] Docker/WSL
34+
- [ ] Visual Studio / IDE caches
35+
- [ ] Windows Update cache
36+
- [ ] Other: ___
37+
38+
## Your experience / Ваш опыт
39+
40+
**What you liked / Что понравилось:**
41+
42+
[Your feedback here]
43+
44+
**Suggestions for improvement / Предложения по улучшению:**
45+
46+
[Optional]
47+
48+
---
49+
50+
Thank you for sharing! Your feedback helps improve WinClean.
51+
Спасибо, что поделились! Ваш отзыв помогает улучшать WinClean.

.github/workflows/ci.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
lint:
11+
name: PSScriptAnalyzer
12+
runs-on: windows-latest
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Run PSScriptAnalyzer
19+
shell: pwsh
20+
run: |
21+
Set-PSRepository PSGallery -InstallationPolicy Trusted
22+
Install-Module PSScriptAnalyzer -Force -Scope CurrentUser
23+
24+
$results = Invoke-ScriptAnalyzer -Path ./WinClean.ps1 -Severity Error,Warning -ReportSummary
25+
26+
if ($results) {
27+
$results | Format-Table -AutoSize
28+
Write-Host ""
29+
Write-Host "::error::PSScriptAnalyzer found $($results.Count) issue(s)"
30+
exit 1
31+
} else {
32+
Write-Host "::notice::PSScriptAnalyzer: No issues found!"
33+
}
34+
35+
syntax:
36+
name: Syntax Check
37+
runs-on: windows-latest
38+
39+
steps:
40+
- name: Checkout repository
41+
uses: actions/checkout@v4
42+
43+
- name: Check PowerShell syntax
44+
shell: pwsh
45+
run: |
46+
$errors = $null
47+
$ast = [System.Management.Automation.Language.Parser]::ParseFile(
48+
"$PWD/WinClean.ps1",
49+
[ref]$null,
50+
[ref]$errors
51+
)
52+
53+
if ($errors) {
54+
Write-Host "::error::Syntax errors found:"
55+
$errors | ForEach-Object { Write-Host " - $_" }
56+
exit 1
57+
} else {
58+
Write-Host "::notice::Syntax check passed!"
59+
}

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
### Ultimate Windows 11 Maintenance Script
88

99
[![Version](https://img.shields.io/badge/version-2.9-blue.svg)](https://github.com/bivlked/WinClean/releases)
10+
[![CI](https://github.com/bivlked/WinClean/actions/workflows/ci.yml/badge.svg)](https://github.com/bivlked/WinClean/actions/workflows/ci.yml)
1011
[![PowerShell 7.1+](https://img.shields.io/badge/PowerShell-7.1%2B-5391FE?logo=powershell&logoColor=white)](https://github.com/PowerShell/PowerShell)
1112
[![Windows 11](https://img.shields.io/badge/Windows-11-0078D4?logo=windows11&logoColor=white)](https://www.microsoft.com/windows/windows-11)
1213
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
@@ -228,6 +229,22 @@ Fast cleanup only
228229

229230
---
230231

232+
## 🎯 Recommended Profiles
233+
234+
Choose the right profile for your needs:
235+
236+
| Profile | Command | Best For |
237+
|:--------|:--------|:---------|
238+
| **Preview** | `.\WinClean.ps1 -ReportOnly` | First run — see what will be cleaned without changes |
239+
| **Safe** | `.\WinClean.ps1 -SkipUpdates -SkipDockerCleanup` | Minimal risk — only temp files and caches |
240+
| **Developer** | `.\WinClean.ps1` | Full cleanup — includes npm, pip, nuget, Docker, IDE caches |
241+
| **Quick** | `.\WinClean.ps1 -SkipUpdates -SkipDevCleanup -SkipVSCleanup` | Fast — system cleanup only, no dev tools |
242+
| **Updates Only** | `.\WinClean.ps1 -SkipCleanup` | Just Windows and app updates |
243+
244+
> 💡 **Tip:** Always run with `-ReportOnly` first to preview what will be cleaned!
245+
246+
---
247+
231248
## 🔧 Requirements
232249

233250
| Requirement | Version | Notes |

README_RU.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
### Комплексный скрипт обслуживания Windows 11
88

99
[![Версия](https://img.shields.io/badge/версия-2.9-blue.svg)](https://github.com/bivlked/WinClean/releases)
10+
[![CI](https://github.com/bivlked/WinClean/actions/workflows/ci.yml/badge.svg)](https://github.com/bivlked/WinClean/actions/workflows/ci.yml)
1011
[![PowerShell 7.1+](https://img.shields.io/badge/PowerShell-7.1%2B-5391FE?logo=powershell&logoColor=white)](https://github.com/PowerShell/PowerShell)
1112
[![Windows 11](https://img.shields.io/badge/Windows-11-0078D4?logo=windows11&logoColor=white)](https://www.microsoft.com/windows/windows-11)
1213
[![Лицензия: MIT](https://img.shields.io/badge/Лицензия-MIT-green.svg)](LICENSE)
@@ -228,6 +229,22 @@ cd WinClean
228229

229230
---
230231

232+
## 🎯 Рекомендуемые профили
233+
234+
Выберите подходящий профиль для ваших нужд:
235+
236+
| Профиль | Команда | Для чего |
237+
|:--------|:--------|:---------|
238+
| **Просмотр** | `.\WinClean.ps1 -ReportOnly` | Первый запуск — посмотреть, что будет очищено, без изменений |
239+
| **Безопасный** | `.\WinClean.ps1 -SkipUpdates -SkipDockerCleanup` | Минимум риска — только временные файлы и кэши |
240+
| **Разработчик** | `.\WinClean.ps1` | Полная очистка — включая npm, pip, nuget, Docker, IDE кэши |
241+
| **Быстрый** | `.\WinClean.ps1 -SkipUpdates -SkipDevCleanup -SkipVSCleanup` | Быстро — только системная очистка |
242+
| **Только обновления** | `.\WinClean.ps1 -SkipCleanup` | Только обновления Windows и приложений |
243+
244+
> 💡 **Совет:** Всегда сначала запускайте с `-ReportOnly` для предпросмотра!
245+
246+
---
247+
231248
## 🔧 Требования
232249

233250
| Требование | Версия | Примечания |

WinClean.ps1

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<#PSScriptInfo
2+
.VERSION 2.9
3+
.GUID 8f7c3b2a-1d4e-5f6a-9b8c-0d1e2f3a4b5c
4+
.AUTHOR bivlked
5+
.COMPANYNAME
6+
.COPYRIGHT (c) 2025 bivlked. MIT License.
7+
.TAGS Windows Cleanup Maintenance PowerShell Windows11 DevTools Docker WSL npm pip nuget
8+
.LICENSEURI https://github.com/bivlked/WinClean/blob/main/LICENSE
9+
.PROJECTURI https://github.com/bivlked/WinClean
10+
.ICONURI https://raw.githubusercontent.com/bivlked/WinClean/main/assets/logo.svg
11+
.EXTERNALMODULEDEPENDENCIES
12+
.REQUIREDSCRIPTS
13+
.EXTERNALSCRIPTDEPENDENCIES
14+
.RELEASENOTES
15+
v2.9: Fixed PSWindowsUpdate installation hanging (TLS 1.2, timeouts)
16+
v2.8: Fixed Disk Cleanup timeout issues
17+
v2.7: UI improvements for final statistics
18+
.PRIVATEDATA
19+
#>
20+
121
<#
222
.SYNOPSIS
323
WinClean - Ultimate Windows 11 Maintenance Script v2.9

0 commit comments

Comments
 (0)