Skip to content

Commit 335d3dd

Browse files
committed
docs: Add changelog entry and update v3 breaking changes
- Add feature and fix entries for SSH key support and authentication validation - Add note to v3 breaking changes about SSH key support in v3.1 - Reference issue #128 and PR #134
1 parent da1a5fd commit 335d3dd

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

CHANGELOG.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@
88
- Scripts receive original and new version as arguments
99
- Support both bash (`.sh`) and PowerShell (`.ps1`) scripts
1010
- Enables workflows like updating lock files, running code generators, or modifying configuration files
11+
- Updater - Add SSH key support and comprehensive authentication validation ([#134](https://github.com/getsentry/github-workflows/pull/134))
12+
- Add `ssh-key` input parameter for deploy key authentication
13+
- Support using both `ssh-key` (for git) and `api-token` (for GitHub API) together
14+
- Add detailed token validation with actionable error messages
15+
- Detect common token issues: expiration, whitespace, SSH keys in wrong input, missing scopes
16+
- Validate SSH key format when provided
1117

1218
### Fixes
1319

1420
- Updater - Fix boolean input handling for `changelog-entry` parameter and add input validation ([#127](https://github.com/getsentry/github-workflows/pull/127))
21+
- Updater - Fix cryptic authentication errors with better validation and error messages ([#134](https://github.com/getsentry/github-workflows/pull/134), closes [#128](https://github.com/getsentry/github-workflows/issues/128))
1522

1623
### Dependencies
1724

@@ -52,7 +59,7 @@
5259
# If a custom token is used instead, a CI would be triggered on a created PR.
5360
api-token: ${{ secrets.CI_DEPLOY_KEY }}
5461
55-
### After
62+
### After (v3.0)
5663
native:
5764
runs-on: ubuntu-latest
5865
steps:
@@ -63,6 +70,23 @@
6370
api-token: ${{ secrets.CI_DEPLOY_KEY }}
6471
```
6572

73+
**Note**: If you were using SSH deploy keys with the v2 reusable workflow, the v3.0 composite action initially only supported tokens.
74+
SSH key support was restored in v3.1 ([#134](https://github.com/getsentry/github-workflows/pull/134)). To use SSH keys, update to v3.1+ and use the `ssh-key` input:
75+
76+
```yaml
77+
### With SSH key (v3.1+)
78+
native:
79+
runs-on: ubuntu-latest
80+
steps:
81+
- uses: getsentry/github-workflows/updater@v3.1 # or @v3 for latest
82+
with:
83+
path: scripts/update-sentry-native-ndk.sh
84+
name: Native SDK
85+
ssh-key: ${{ secrets.CI_DEPLOY_KEY }}
86+
# Optionally also provide api-token for GitHub API operations
87+
# api-token: ${{ secrets.GITHUB_TOKEN }}
88+
```
89+
6690
To update your existing Danger workflows:
6791

6892
```yaml

0 commit comments

Comments
 (0)