Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drone/go-scm
Package scm provides a unified interface to multiple source code management systems.
https://github.com/drone/go-scm
bitbucket bitbucket-server gitea github github-enterprise gitlab gogs scm vcs
Last synced: 3 months ago
JSON representation
Package scm provides a unified interface to multiple source code management systems.
- Host: GitHub
- URL: https://github.com/drone/go-scm
- Owner: drone
- License: other
- Created: 2017-12-07T23:18:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T06:59:11.000Z (3 months ago)
- Last Synced: 2024-10-28T16:29:53.943Z (3 months ago)
- Topics: bitbucket, bitbucket-server, gitea, github, github-enterprise, gitlab, gogs, scm, vcs
- Language: Go
- Homepage: https://godoc.org/github.com/drone/go-scm/scm#pkg-examples
- Size: 1.56 MB
- Stars: 174
- Watchers: 12
- Forks: 235
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# go-scm
[](http://godoc.org/github.com/drone/go-scm/scm)
Package scm provides a unified interface to multiple source code management systems including GitHub, GitHub Enterprise, Bitbucket, Bitbucket Server, Gitee, Gitea and Gogs.
## Getting Started
Create a GitHub client:
```Go
package main
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/github"
)
func main() {
client := github.NewDefault()
}
```
Create a GitHub Enterprise client:
```Go
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/github"
)
func main() {
client, err := github.New("https://github.company.com/api/v3")
}
```
Create a Bitbucket client:
```Go
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/bitbucket"
)
func main() {
client, err := bitbucket.New()
}
```
Create a Bitbucket Server (Stash) client:
```Go
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/stash"
)
func main() {
client, err := stash.New("https://stash.company.com")
}
```
Create a Gitea client:
```Go
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/gitea"
)
func main() {
client, err := gitea.New("https://gitea.company.com")
}
```
Create a Gitee client:
```Go
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/gitee"
)
func main() {
client, err := gitee.New("https://gitee.com/api/v5")
}
```
## Authentication
The scm client does not directly handle authentication. Instead, when creating a new client, provide an `http.Client` that can handle authentication for you. For convenience, this library includes oauth1 and oauth2 implementations that can be used to authenticate requests.
```Go
package main
import (
"github.com/drone/go-scm/scm"
"github.com/drone/go-scm/scm/driver/github"
"github.com/drone/go-scm/scm/transport"
"github.com/drone/go-scm/scm/transport/oauth2"
)
func main() {
client := github.NewDefault()
// provide a custom http.Client with a transport
// that injects the oauth2 token.
client.Client = &http.Client{
Transport: &oauth2.Transport{
Source: oauth2.StaticTokenSource(
&scm.Token{
Token: "ecf4c1f9869f59758e679ab54b4",
},
),
},
}
// provide a custom http.Client with a transport
// that injects the private GitLab token through
// the PRIVATE_TOKEN header variable.
client.Client = &http.Client{
Transport: &transport.PrivateToken{
Token: "ecf4c1f9869f59758e679ab54b4",
},
}
}
```
## Usage
The scm client exposes dozens of endpoints for working with repositories, issues, comments, files and more. Please see the [godocs](https://pkg.go.dev/github.com/drone/go-scm/scm#pkg-examples) to learn more.
Example code to get an issue:
```Go
issue, _, err := client.Issues.Find(ctx, "octocat/Hello-World", 1)
```
Example code to get a list of issues:
```Go
opts := scm.IssueListOptions{
Page: 1,
Size: 30,
Open: true,
Closed: false,
}
issues, _, err := client.Issues.List(ctx, "octocat/Hello-World", opts)
```
Example code to create an issue comment:
```Go
in := &scm.CommentInput{
Body: "Found a bug",
}
comment, _, err := client.Issues.CreateComment(ctx, "octocat/Hello-World", 1, in)
```
## Useful links
Here are some useful links to providers API documentation:
- [Azure DevOps](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/?view=azure-devops-rest-6.0)
- [Bitbucket cloud API](https://developer.atlassian.com/cloud/bitbucket/rest/intro/)
- [Bitbucket server/Stash API](https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html)
- [Gitea API](https://gitea.com/api/swagger/#/)
- [Gitee API](https://gitee.com/api/swagger/#/)
- [Github API](https://docs.github.com/en/rest/reference)
- [Gitlab API](https://docs.gitlab.com/ee/api/api_resources.html)
- [Gogs API](https://github.com/gogs/docs-api)
## Release procedure
Run the changelog generator.
```BASH
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p go-scm -t
```
You can generate a token by logging into your GitHub account and going to Settings -> Personal access tokens.
Next we tag the PR's with the fixes or enhancements labels. If the PR does not fufil the requirements, do not add a label.
Run the changelog generator again with the future version according to semver.
```BASH
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p go-scm -t --future-release v1.15.2
```
Create your pull request for the release. Get it merged then tag the release.