https://github.com/octokit/source-generator

Generates SDKs from GitHub's OpenAPI specification. Built on Kiota.
https://github.com/octokit/source-generator

Last synced: 7 months ago
JSON representation

Generates SDKs from GitHub's OpenAPI specification. Built on Kiota.

• Host: GitHub
• URL: https://github.com/octokit/source-generator
• Owner: octokit
• Created: 2023-01-18T16:18:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-20T21:41:09.000Z (12 months ago)
• Last Synced: 2025-02-24T05:03:45.172Z (11 months ago)
• Language: C#
• Homepage:
• Size: 8.8 MB
• Stars: 8
• Watchers: 3
• Forks: 5
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# source-generator

This repository generates code from [GitHub's OpenAPI specification](https://github.com/github/rest-api-description), built on [Kiota](https://github.com/microsoft/kiota). If you're looking for the repositories generated from this code, you may want:

- Go

	- For the standard GitHub.com product

		- [go-sdk repository](https://github.com/octokit/go-sdk)

		- [pkg.go.dev docs link](https://pkg.go.dev/github.com/octokit/go-sdk)

	- For GitHub Enterprise Cloud

		- [go-sdk-enterprise-cloud repository](https://github.com/octokit/go-sdk-enterprise-cloud)

		- [pkg.go.dev docs link](https://pkg.go.dev/github.com/octokit/go-sdk-enterprise-cloud)

	- For GitHub Enterprise Server

		- [go-sdk-enterprise-server repository](https://github.com/octokit/go-sdk-enterprise-server)

		- [pkg.go.dev docs link](https://pkg.go.dev/github.com/octokit/go-sdk-enterprise-server)

- .NET

	- For the standard GitHub.com product

		- [dotnet-sdk repository](https://github.com/octokit/dotnet-sdk)

		- [NuGet link](https://www.nuget.org/packages/GitHub.Octokit.SDK)

	- For GitHub Enterprise Cloud

		- [dotnet-sdk-enterprise-cloud repository](https://github.com/octokit/dotnet-sdk-enterprise-cloud)

		- [NuGet link](https://www.nuget.org/packages/GitHub.Octokit.GHEC.SDK/)

	- For GitHub Enterprise Server

		- [dotnet-sdk-enterprise-server repository](https://github.com/octokit/dotnet-sdk-enterprise-server)

		- [NuGet link](https://www.nuget.org/packages?q=GitHub.Octokit.GHES.SDK)

	- For our classic non-generated, hand-maintained Octokit.net project

		- [Octokit.net repository](https://github.com/octokit/octokit.net)

		- [NuGet link](https://www.nuget.org/packages/Octokit/)

## Development

- Install

	- [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)

	- [Latest version of Go](https://go.dev/dl/)

	- Kiota: `dotnet tool install --global Microsoft.OpenApi.Kiota --prerelease`

- For the latest versions of tooling, the `.github/workflows/build-go.yml` file is the source of truth.

## Usage

### Go

Run `./scripts/generate-go.sh`. You may also run individual steps from the `.github/workflows/build-go.yml` file. If you're using VSCode, there are some pre-setup tasks and debugging configurations in the `.vscode` folder.

### C#

Run `./scripts/generate-csharp.sh`

## Design 

For more information on our approach to generative SDKs please read our [design doc](./docs/DESIGN.md).  

For more information on why we have made a move toward Generative SDKs, please take a moment and head over to the [GitHub blog](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/) to read more there.