Skip to content

Commit c4ebd1c

Browse files
committed
docs(release): update release notes for v1.1.8 and archive previous version
- Update RELEASE_NOTES.md with new information for v1.1.8 release - Move previous release notes to RELEASE_NOTES_ARCHIVE.md - Add new release notes backup pattern to .gitignore Signed-off-by: diverger <[email protected]>
1 parent e8a6c52 commit c4ebd1c

File tree

3 files changed

+66
-13
lines changed

3 files changed

+66
-13
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,4 @@ test-files/
7070

7171
# Test files - ignore large binary files
7272
test-files/large-file.bin
73+
/RELEASE_NOTES_backup_*.md

RELEASE_NOTES.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,51 @@
11
# Release Notes
22

3-
## 🚀 GH OBS Helper Release v1.1.7
3+
## 🚀 GH OBS Helper Release v1.1.8
44

55
### 🎯 What's New
6-
- **Enhanced CI/CD Testing**: Improved workflow testing with comprehensive URL output validation
7-
- **Workflow Organization**: Renamed and restructured test workflows for better clarity
8-
- **Security Improvements**: Enhanced secret management in CI/CD workflows
6+
- **Enhanced Documentation**: Added professional badges for license, release, and build status to README.md
7+
- **CI/CD Improvements**: Streamlined GitHub release workflow with modern action
8+
- **Repository Cleanup**: Added automated workflow run cleanup for better repository maintenance
99

1010
### 🔧 Changes
11-
- **CI Workflow Updates**: Enabled checksum validation for large file uploads in testing workflows
12-
- **Test Infrastructure**: Added dedicated URL output testing and improved upload test results validation
13-
- **Security Configuration**: Updated workflow files to use secure OBS region configuration via secrets
14-
- **Workflow Naming**: Renamed `test-url-outputs.yml` workflow to `test-url-usage.yml` for better clarity
11+
- **Documentation Updates**: Updated README.md with status badges for better project visibility
12+
- **Package Metadata**: Updated author information in package.json
13+
- **CI/CD Modernization**: Switched from deprecated actions/create-release to softprops/action-gh-release
14+
- **Workflow Cleanup**: Added automated cleanup of old workflow runs to maintain repository hygiene
1515

1616
### 🐛 Bug Fixes
17-
- **Large File Upload Testing**: Fixed checksum validation issues during large file upload tests
18-
- **Workflow Configuration**: Resolved configuration inconsistencies in CI/CD test workflows
19-
- **Secret Management**: Improved handling of sensitive configuration in automated tests
17+
- **Release Process**: Improved GitHub release creation workflow reliability
18+
- **Repository Maintenance**: Implemented automatic cleanup to prevent workflow run accumulation
2019

2120
### 📋 Known Issues
2221
- No known issues in this release
2322
- All existing functionality remains stable
2423

2524
### 🔗 Migration Guide
26-
- No breaking changes from v1.1.6
25+
- No breaking changes from v1.1.7
2726
- All existing workflows remain fully compatible
2827
- No code changes required for users
2928

29+
### 🛠️ Usage Example
30+
```yaml
31+
- name: Upload to OBS
32+
id: upload
33+
uses: diverger/[email protected]
34+
with:
35+
access_key: ${{ secrets.OBS_ACCESS_KEY }}
36+
secret_key: ${{ secrets.OBS_SECRET_KEY }}
37+
region: 'cn-north-4'
38+
bucket: 'my-bucket'
39+
operation: 'upload'
40+
local_path: 'dist/**/*'
41+
obs_path: 'releases/v1.1.8/'
42+
public_read: true
43+
44+
- name: Use uploaded file URLs
45+
run: |
46+
echo "First file URL: ${{ steps.upload.outputs.first_upload_url }}"
47+
echo "All URLs: ${{ steps.upload.outputs.upload_urls }}"
48+
```
49+
3050
---
31-
**Full Changelog**: https://github.com/diverger/gh-obs-helper/compare/v1.1.6...v1.1.7
51+
**Full Changelog**: https://github.com/diverger/gh-obs-helper/compare/v1.1.7...v1.1.8

RELEASE_NOTES_ARCHIVE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,38 @@ This file contains archived release notes for older versions of GH OBS Helper.
44

55
---
66

7+
## 🚀 GH OBS Helper Release v1.1.7
8+
9+
### 🎯 What's New
10+
- **Enhanced CI/CD Testing**: Improved workflow testing with comprehensive URL output validation
11+
- **Workflow Organization**: Renamed and restructured test workflows for better clarity
12+
- **Security Improvements**: Enhanced secret management in CI/CD workflows
13+
14+
### 🔧 Changes
15+
- **CI Workflow Updates**: Enabled checksum validation for large file uploads in testing workflows
16+
- **Test Infrastructure**: Added dedicated URL output testing and improved upload test results validation
17+
- **Security Configuration**: Updated workflow files to use secure OBS region configuration via secrets
18+
- **Workflow Naming**: Renamed `test-url-outputs.yml` workflow to `test-url-usage.yml` for better clarity
19+
20+
### 🐛 Bug Fixes
21+
- **Large File Upload Testing**: Fixed checksum validation issues during large file upload tests
22+
- **Workflow Configuration**: Resolved configuration inconsistencies in CI/CD test workflows
23+
- **Secret Management**: Improved handling of sensitive configuration in automated tests
24+
25+
### 📋 Known Issues
26+
- No known issues in this release
27+
- All existing functionality remains stable
28+
29+
### 🔗 Migration Guide
30+
- No breaking changes from v1.1.6
31+
- All existing workflows remain fully compatible
32+
- No code changes required for users
33+
34+
---
35+
**Full Changelog**: https://github.com/diverger/gh-obs-helper/compare/v1.1.6...v1.1.7
36+
37+
---
38+
739
## 🚀 GH OBS Helper Release v1.1.6
840

941
### 🔧 Changes

0 commit comments

Comments
 (0)