Skip to content

Commit f5487fb

Browse files
edburnsCopilot
andcommitted
Add notes.template for Java release notes
Copied verbatim from copilot-sdk-java. Used by java-publish-maven.yml via envsubst to generate GitHub Release notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 052cbcf commit f5487fb

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

.github/workflows/notes.template

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Installation
2+
3+
ℹ️ **Public Preview:** This is the official Java SDK for GitHub Copilot. This repository treats the official .NET and Node.js SDKs for GitHub Copilot as reference implementations. These SDKs are all officially supported as GitHub open source projects. The Java implementation follows the backward compatibility guarantees offered by the reference implementations. While in public preview, minor breaking changes may still occur between releases.
4+
5+
⚠️ **Artifact versioning plan:** Releases of this implementation track releases of the reference implementation. For each release of the reference implementation, there may follow a corresponding relase of this implementation with the same number as the reference implementation. Release identifiers of the reference implementation are in the form `vMaj.Min.Micro`. For example v0.1.32. The corresponding maven version for the release will be `Maj.Min.Micro-java.N`, where `Maj`, `Min` and `Micro` are the corresponding numbers for the reference impementation release, and `N` is a monotonically increasing sequence number starting with 0 for each release. See the corrseponding architectural decision record for more information in the `docs/adr` directory of the source code.
6+
7+
📦 [View on Maven Central](https://central.sonatype.com/artifact/${GROUP_ID}/${ARTIFACT_ID}/${VERSION})
8+
9+
📖 [Documentation](https://github.github.io/copilot-sdk-java/${VERSION}/) · [Javadoc](https://github.github.io/copilot-sdk-java/${VERSION}/apidocs/index.html)
10+
11+
## Maven
12+
```xml
13+
<dependency>
14+
<groupId>${GROUP_ID}</groupId>
15+
<artifactId>${ARTIFACT_ID}</artifactId>
16+
<version>${VERSION}</version>
17+
</dependency>
18+
```
19+
20+
## Gradle (Kotlin DSL)
21+
```kotlin
22+
implementation("${GROUP_ID}:${ARTIFACT_ID}:${VERSION}")
23+
```
24+
25+
## Gradle (Groovy DSL)
26+
```groovy
27+
implementation '${GROUP_ID}:${ARTIFACT_ID}:${VERSION}'
28+
```

0 commit comments

Comments
 (0)