Skip to content

Latest commit

 

History

History
106 lines (77 loc) · 7.77 KB

README.md

File metadata and controls

106 lines (77 loc) · 7.77 KB
Raw

Important

This SDK is not yet stable. Breaking changes may occur at any time.

github.com/octokit/go-sdk

An "alpha" version of a generated Go SDK for the standard GitHub.com product, generated from GitHub's OpenAPI spec, built on Kiota.

You may also want:

How do I use it?

See example client instantiations and requests in example_test.go or in the cmd/ directory.

Building and testing

  • Build the SDK: go build ./...
  • Test the SDK: go test ./...
    • Measure test coverage by package (e.g. authentication): go test -v -coverpkg=./pkg/authentication -coverprofile=auth.cov ./pkg/authentication
    • Test coverage may be viewed in VS Code by running the command Go: Toggle Test Coverage In Current Package
    • Alternately, you may run go tool cover -html auth.cov -o auth.html and open the generated auth.html file in a browser to view test coverage

Authentication

This SDK supports Personal Access Tokens (classic), fine-grained Personal Access Tokens, and GitHub Apps authentication.

In order to use either type of Personal Access token, you can use the WithTokenAuthentication("YOUR_TOKEN_HERE") functional option when constructing a client, like so:

client, err := pkg.NewApiClient(
	pkg.WithTokenAuthentication(os.Getenv("GITHUB_TOKEN")),
)
if err != nil {
	log.Fatalf("error creating client: %v", err)
}

In order to authenticate as a GitHub App, you can use the WithGitHubAppAuthentication functional option:

client, err := pkg.NewApiClient(
	pkg.WithGitHubAppAuthentication("/path/to/your/pem/file.pem", "your-client-ID", yourInstallationIDInt),
)
if err != nil {
	log.Fatalf("error creating client: %v", err)
}

To see more detailed examples, view the cmd/ directory in this repo.

⚠️ Note: There are three types of GitHub App authentication:

  1. As the App itself (meta endpoints)
  2. As an App installation
  3. On behalf of a user

Authenticating on behalf of a user is not supported in an SDK, as it requires a UI authentication flow with redirects. This SDK supports authenticating as the App itself and as an App installation.

Note that the SDK does not yet support authenticating as the App itself and as an App installation using the same client transparently to the user. Authenticating as the App itself requires creating a JSON Web Token (JWT) and using that as token authentication. For helpers to create and sign a JWT in Go, you may use the golang-jwt/jwt library.

Authenticating as an App installation can be done using the WithGitHubAppAuthentication functional option. Future work is planned to make the App meta endpoints vs. App installation endpoints auth schemes transparent to the user and only require one client setup.

Why a generated SDK?

Please take a moment and head over to the GitHub blog to read more about the why's and how's behind our move to Generative SDKs.

Why Go?

We don't currently support a Go SDK and we wanted a narrow scope for the initial effort without worrying about cutting over users of an existing SDK.

How can I report on my experience or issues with the SDK?

Please use this project's issues!

Releasing this project

Periodically (based on the frequency of this workflow), the source-generator repository will ingest the latest version of GitHub's OpenAPI spec and generate a new version of this SDK. If there is a diff, a PR (similar to this one) will be generated.

When reviewing the PR, analyze the diff and determine whether the changes are breaking (for which a major version number must be incremented), feature additions (for which a minor version number must be incremented), or bug fixes or docs changes (for which a patch number must be incremented). For more details about how to select an appropriate semantic version, see semver.org. In many/most cases, due to the scale of GitHub's specification and the rate of change on it, the diff will be large and the changes will be technically breaking. This will mean incrementing a major version number. If a major version is being incremented, it must be changed in the go.mod file as described in these docs.

When changes are analyzed, change the PR title appropriately (see this PR for an example) and merge it. Then go to repository releases, tag the release with the chosen version, title it with the chosen version, use the "Generate release notes" button to see what PRs will be included in the release, and manually edit the release notes grouping the changes under the headings Features, Fixes, Maintenance, and Documentation when appropriate. After clicking "Publish Release", the new version will be available for use!