A powerful VSCode extension designed for Debian package developers to intelligently generate high-quality changelog entries. Say goodbye to manual changelog writing!
- Git Integration: Automatically extract changes from Git commit history
- Issue Tracking: Support for GitHub/GitLab Issue system integration
- Smart Analysis: Automatically determine urgency levels based on commit content
- File Awareness: Identify important file changes and add them to changelog
- Standard Format: Strictly follows Debian changelog format specifications
- Version Management: Smart version number incrementing
- Date Formatting: Automatically generates RFC 2822 formatted dates
- Author Information: Automatic configuration and use of author details
- Keyboard Shortcuts: Support for custom keyboard shortcuts
- Command Palette: Integrated into VSCode command palette
- Rich Configuration: Extensive configuration options for different needs
- Open VSCode
- Press
Ctrl+Pto open Quick Open - Type
ext install yixinshark.smart-debian-changelog - Restart VSCode
- Download the latest
.vsixfile from Releases - Open VSCode
- Press
Ctrl+Shift+Pand runExtensions: Install from VSIX... - Select the downloaded file
First time users should configure their name and email:
Ctrl+Shift+P -> "Debian: Configure User Information"
In your debian/changelog file, use the shortcut:
Ctrl+Alt+D
Ctrl+Alt+G
| Setting | Description | Default |
|---|---|---|
debianChangelog.author.name |
Author name | "" |
debianChangelog.author.email |
Author email | "" |
debianChangelog.defaultDistribution |
Default distribution | "unstable" |
debianChangelog.defaultUrgency |
Default urgency level | "medium" |
debianChangelog.gitCommitRange |
Git commit range | "HEAD~10..HEAD" |
debianChangelog.includeIssueDetails |
Include Issue details | true |
debianChangelog.github.token |
GitHub access token | "" |
debianChangelog.gitlab.token |
GitLab access token | "" |
Configure API tokens to enable automatic Issue details retrieval:
- Visit GitHub Token Settings
- Generate a new personal access token
- For public repos: no special permissions needed
- For private repos:
repopermission required - Configure in VSCode settings:
debianChangelog.github.token
- Visit GitLab Token Settings
- Create a new personal access token
- Required permission:
read_api - Configure in VSCode settings:
debianChangelog.gitlab.token
| Command | Shortcut | Description |
|---|---|---|
debian-changelog.generate |
Ctrl+Alt+D |
Generate basic changelog entry |
debian-changelog.generateFromGit |
Ctrl+Alt+G |
Generate changelog from Git commits |
debian-changelog.configure |
- | Configure user information |
| Feature | Existing Plugins | Smart Debian Changelog | Advantage |
|---|---|---|---|
| Basic template | ✅ | ✅ | Same |
| Git integration | ❌ | ✅ | Full automation |
| Issue tracking | ❌ | ✅ | Smart context |
| Smart analysis | ❌ | ✅ | Auto detection |
| Version management | ❌ | ✅ | Auto increment |
| File change awareness | ❌ | ✅ | Detailed tracking |
| Multi-platform support | ❌ | ✅ | GitHub/GitLab |
一个强大的VSCode插件，专为Debian包开发者设计，能够智能生成高质量的changelog条目。告别手动编写changelog的时代！
- Git集成: 自动从Git提交历史提取变更信息
- Issue跟踪: 支持GitHub/GitLab Issue系统集成
- 智能分析: 根据提交内容自动判断紧急程度
- 文件感知: 识别重要文件变更并添加到changelog
- 标准格式: 严格遵循Debian changelog格式规范
- 版本管理: 智能版本号递增
- 日期格式: 自动生成RFC 2822格式的日期
- 作者信息: 自动配置和使用作者信息
- 快捷键: 支持自定义快捷键操作
- 命令面板: 集成到VSCode命令面板
- 丰富配置: 多样的配置选项满足不同需求
- 打开VSCode
- 按
Ctrl+P打开Quick Open - 输入
ext install yixinshark.smart-debian-changelog - 重启VSCode
- 从发布页面下载最新的
.vsix文件 - 打开VSCode
- 按
Ctrl+Shift+P运行Extensions: Install from VSIX... - 选择下载的文件
第一次使用时，请配置您的姓名和邮箱：
Ctrl+Shift+P -> "Debian: 配置用户信息"
在debian/changelog文件中，按快捷键：
Ctrl+Alt+D
Ctrl+Alt+G
| 配置项 | 说明 | 默认值 |
|---|---|---|
debianChangelog.author.name |
作者姓名 | "" |
debianChangelog.author.email |
作者邮箱 | "" |
debianChangelog.defaultDistribution |
默认发行版 | "unstable" |
debianChangelog.defaultUrgency |
默认紧急程度 | "medium" |
debianChangelog.gitCommitRange |
Git提交范围 | "HEAD~10..HEAD" |
debianChangelog.includeIssueDetails |
包含Issue详情 | true |
debianChangelog.github.token |
GitHub访问令牌 | "" |
debianChangelog.gitlab.token |
GitLab访问令牌 | "" |
配置API访问令牌以启用Issue详情自动获取功能：
- 访问 GitHub Token Settings
- 生成新的个人访问令牌
- 公开仓库：无需特殊权限
- 私有仓库：需要
repo权限 - 在VSCode设置中配置：
debianChangelog.github.token
- 访问 GitLab Token Settings
- 创建新的个人访问令牌
- 所需权限：
read_api - 在VSCode设置中配置：
debianChangelog.gitlab.token
| 命令 | 快捷键 | 说明 |
|---|---|---|
debian-changelog.generate |
Ctrl+Alt+D |
生成基本changelog条目 |
debian-changelog.generateFromGit |
Ctrl+Alt+G |
从Git提交生成changelog |
debian-changelog.configure |
- | 配置用户信息 |
We welcome all forms of contributions! | 我们欢迎所有形式的贡献！
- Fork this repository | Fork 这个仓库
- Create your feature branch | 创建您的功能分支 (
git checkout -b feature/AmazingFeature) - Commit your changes | 提交您的更改 (
git commit -m 'Add some AmazingFeature') - Push to the branch | 推送到分支 (
git push origin feature/AmazingFeature) - Open a Pull Request | 打开一个 Pull Request
# Clone the repository | 克隆仓库
git clone https://github.com/yixinshark/auto-create-Debian-changelog.git
cd auto-create-Debian-changelog
# Install dependencies | 安装依赖
npm install
# Compile the project | 编译项目
npm run compile
# Debug in VSCode | 在VSCode中调试
# Press F5 to start debugging mode | 按F5启动调试模式If you find a bug or have a feature request, please create an issue.
如果您发现了bug或有功能建议，请创建一个issue。
This project is licensed under the MIT License - see the LICENSE file for details.
本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。
- Thanks to all developers contributing to the Debian ecosystem | 感谢所有为Debian生态系统做出贡献的开发者
- Thanks to the VSCode extension development community | 感谢VSCode扩展开发社区的支持
- Thanks to all testers for their feedback | 感谢所有测试用户的反馈
🎉 Make Debian changelog management simple and efficient! | 让Debian包的changelog管理变得简单高效！ 🎉
⭐ If this project helps you, please give us a Star! | ⭐ 如果这个项目对您有帮助，请给我们一个Star！