Skip to content

Commit 88af75a

Browse files
committed
fix: add version.go and bump version number
1 parent 14adaec commit 88af75a

File tree

3 files changed

+23
-2
lines changed

3 files changed

+23
-2
lines changed

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"makefile.configureOnOpen": false
3+
}

pkg/onelogin/version.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package onelogin
2+
3+
const Version = "1.2.0"

readme.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Onelogin Go SDK
32

43
This is the Onelogin SDK, a Go package that provides a convenient interface for interacting with Onelogin's API. The SDK simplifies the integration process by providing developers an easy-to-use tool for managing authentication, making API requests, and handling responses.
@@ -104,7 +103,23 @@ func main() {
104103
}
105104
fmt.Println("App List:", appList)
106105
}
107-
```
106+
107+
## Releasing
108+
109+
When releasing a new version of the SDK:
110+
111+
1. Update the version number in `pkg/onelogin/version.go` following semantic versioning:
112+
- MAJOR version for incompatible API changes
113+
- MINOR version for backwards-compatible functionality additions
114+
- PATCH version for backwards-compatible bug fixes
115+
116+
2. Commit the version change:
117+
```shell
118+
git add pkg/onelogin/version.go
119+
git commit -m "Bump version to x.y.z"
120+
git tag vx.y.z
121+
git push origin main --tags
122+
```
108123

109124
## Documentation
110125

0 commit comments

Comments
 (0)