diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000000..460f782006 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f60625ec15..078e236d65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ We welcome: - Bug fixes with clear reproduction steps - Improvements to documentation - Making the SDKs more idiomatic and nice to use for each supported language -- Bug reports and feature suggestions on [our issue tracker](https://github.com/github/copilot-sdk/issues) — especially for bugs with repro steps +- Bug reports and feature suggestions on [our issue tracker](https://github.com/Unity-Billal-mesloub/copilot-sdk/issues) — especially for bugs with repro steps We are generally **not** looking for: @@ -49,7 +49,7 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl ### Python SDK 1. Install [Python 3.8+](https://www.python.org/downloads/) -1. Install [uv](https://github.com/astral-sh/uv) +1. Install [uv](https://github.com/Unity-Billal-mesloub/uv) 1. Install dependencies: `cd python && uv pip install -e . --group dev` ### Go SDK diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 28a50fa226..0000000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright GitHub, Inc. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index 5ad2b71270..8e3f75800b 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,12 @@ The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production- | SDK | Location | Cookbook | Installation | API docs | | ------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| **Node.js / TypeScript** | [`nodejs/`](./nodejs/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/nodejs/README.md) | `npm install @github/copilot-sdk` | | -| **Python** | [`python/`](./python/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/python/README.md) | `pip install github-copilot-sdk` | | -| **Go** | [`go/`](./go/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/README.md) | `go get github.com/github/copilot-sdk/go` | [API docs](https://pkg.go.dev/github.com/github/copilot-sdk/go) | -| **.NET** | [`dotnet/`](./dotnet/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` | | +| **Node.js / TypeScript** | [`nodejs/`](./nodejs/) | [Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk/nodejs/README.md) | `npm install @github/copilot-sdk` | | +| **Python** | [`python/`](./python/) | [Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk/python/README.md) | `pip install github-copilot-sdk` | | +| **Go** | [`go/`](./go/) | [Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk/go/README.md) | `go get github.com/github/copilot-sdk/go` | [API docs](https://pkg.go.dev/github.com/github/copilot-sdk/go) | +| **.NET** | [`dotnet/`](./dotnet/) | [Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` | | | **Rust** | [`rust/`](./rust/) | — | `cargo add github-copilot-sdk` | [API docs](https://docs.rs/github-copilot-sdk/latest/github_copilot_sdk/) | -| **Java** | [`java/`](./java/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/java/README.md) | Maven coordinates
`com.github:copilot-sdk-java`
See instructions for [Maven](./java/README.md#maven) and [Gradle](./java/README.md#gradle) | [API docs](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/) | +| **Java** | [`java/`](./java/) | [Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk/java/README.md) | Maven coordinates
`com.github:copilot-sdk-java`
See instructions for [Maven](./java/README.md#maven) and [Gradle](./java/README.md#gradle) | [API docs](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/) | See the individual SDK READMEs for installation, usage examples, and API reference. @@ -104,12 +104,12 @@ Yes, the GitHub Copilot SDK allows you to define custom agents, skills, and tool Yes, check out the custom instructions and SDK-specific guidance: -- **[Node.js / TypeScript](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-nodejs.instructions.md)** -- **[Python](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-python.instructions.md)** -- **[.NET](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-csharp.instructions.md)** -- **[Go](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-go.instructions.md)** +- **[Node.js / TypeScript](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/instructions/copilot-sdk-nodejs.instructions.md)** +- **[Python](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/instructions/copilot-sdk-python.instructions.md)** +- **[.NET](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/instructions/copilot-sdk-csharp.instructions.md)** +- **[Go](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/instructions/copilot-sdk-go.instructions.md)** - **[Rust](./rust/README.md)** (SDK guidance; custom instructions not yet published) -- **[Java](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-java.instructions.md)** +- **[Java](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/instructions/copilot-sdk-java.instructions.md)** ### What models are supported? @@ -121,7 +121,7 @@ The GitHub Copilot SDK is generally available and follows semantic versioning. S ### How do I report issues or request features? -Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) page to report bugs or request new features. We welcome your feedback to help improve the SDK. +Please use the [GitHub Issues](https://github.com/Unity-Billal-mesloub/copilot-sdk/issues) page to report bugs or request new features. We welcome your feedback to help improve the SDK. ## Quick Links @@ -131,8 +131,8 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag - **[Authentication](./docs/auth/README.md)** – GitHub OAuth, BYOK, and more - **[Features](./docs/features/README.md)** – Hooks, custom agents, MCP, skills, and more - **[Troubleshooting](./docs/troubleshooting/debugging.md)** – Common issues and solutions -- **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages -- **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources +- **[Cookbook](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages +- **[More Resources](https://github.com/Unity-Billal-mesloub/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources ## Unofficial, Community-maintained SDKs @@ -143,13 +143,11 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag | **Clojure** | [copilot-community-sdk/copilot-sdk-clojure][sdk-clojure] | | **C++** | [0xeb/copilot-sdk-cpp][sdk-cpp] | -[sdk-cpp]: https://github.com/0xeb/copilot-sdk-cpp -[sdk-clojure]: https://github.com/copilot-community-sdk/copilot-sdk-clojure +[sdk-cpp]: https://github.com/Unity-Billal-mesloub/copilot-sdk-cpp + ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines. -## License -MIT