Skip to content

Commit 3ab7945

Browse files
committed
chore: add initial CHANGELOG.md file
Introduces a changelog documenting all notable changes, releases, and contributors for the project, following Keep a Changelog and Semantic Versioning standards.
1 parent 3068f1c commit 3ab7945

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

CHANGELOG.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [v1.2.1] - 2025-08-08
9+
10+
### Fixed
11+
12+
- **Security**: Fixed JWT vulnerability GO-2025-3553 by upgrading jwt dependency to v5.3.0 (#9)
13+
14+
**Contributors**: @grinish21
15+
16+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.2.0...v1.2.1>
17+
18+
## [v1.2.0] - 2025-03-18
19+
20+
### Changed
21+
22+
- Bumped dependencies to latest versions (#8)
23+
24+
**Contributors**: @candiepih (first contribution)
25+
26+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.1.1...v1.2.0>
27+
28+
## [v1.1.1] - 2024-09-09
29+
30+
### Fixed
31+
32+
- Fixed 404 links in README documentation (#3)
33+
34+
### Changed
35+
36+
- Bumped dependencies to latest versions (#6)
37+
- Upgraded Go version to 1.23 (#7)
38+
39+
**Contributors**: @grinish21 (first contribution), @jferrl
40+
41+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.1.0...v1.1.1>
42+
43+
## [v1.1.0] - 2024-08-10
44+
45+
### Added
46+
47+
- GitHub Enterprise Server compatibility
48+
49+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.0.2...v1.1.0>
50+
51+
## [v1.0.2] - 2024-06-07
52+
53+
### Changed
54+
55+
- Minor improvements and bug fixes
56+
57+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.0.1...v1.0.2>
58+
59+
## [v1.0.1] - 2024-06-01
60+
61+
### Changed
62+
63+
- Minor improvements and bug fixes
64+
65+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/compare/v1.0.0...v1.0.1>
66+
67+
## [v1.0.0] - 2024-06-01
68+
69+
### Added
70+
71+
- **Initial Release**: GitHub authentication utilities for Go applications
72+
- **JWT Generation**: Generate JSON Web Tokens (JWT) for GitHub Apps using `NewApplicationTokenSource`
73+
- **Installation Tokens**: Obtain GitHub App installation tokens using `NewInstallationTokenSource`
74+
- **Security Compliance**:
75+
- JWT expiration time limited to 10 minutes maximum
76+
- Clock drift protection with 60-second buffer
77+
- **Configuration Options**:
78+
- `WithApplicationTokenExpiration`: Customize JWT token expiration
79+
- `WithHTTPClient`: Set custom HTTP client
80+
- `WithInstallationTokenOptions`: Configure installation token options
81+
- **OAuth2 Integration**: Full compatibility with `golang.org/x/oauth2.TokenSource` interface
82+
83+
### Documentation
84+
85+
- Comprehensive README with usage examples
86+
- Integration examples with `go-github` library
87+
88+
**Full Changelog**: <https://github.com/jferrl/go-githubauth/commits/v1.0.0>
89+
90+
---
91+
92+
## About This Project
93+
94+
`go-githubauth` is a Go package that provides utilities for GitHub authentication, including generating and using GitHub App tokens and installation tokens. It implements the `TokenSource` interface from the `golang.org/x/oauth2` package for seamless integration with existing OAuth2 workflows.
95+
96+
### Key Features
97+
98+
- Generate GitHub Application JWT tokens
99+
- Obtain GitHub App installation tokens
100+
- RS256-signed JWTs with proper clock drift protection
101+
- Full OAuth2 compatibility
102+
- GitHub Enterprise Server support
103+
104+
For more information, see the [README](README.md).

0 commit comments

Comments
 (0)