Skip to content

Commit 29e0dc2

Browse files
committed
Update README and workflow files for version 1.0.0 release, enhancing installation instructions and removing unnecessary environment variables
1 parent 6d0cde7 commit 29e0dc2

3 files changed

Lines changed: 19 additions & 23 deletions

File tree

.github/workflows/publish-maven.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,11 @@ jobs:
8787
ARTIFACT_ID="copilot-sdk"
8888
8989
RELEASE_NOTES=$(cat <<EOF
90-
## Installation
90+
# Installation
9191
92-
### Maven
92+
📦 [View on Maven Central](https://central.sonatype.com/artifact/${GROUP_ID}/${ARTIFACT_ID}/${VERSION})
93+
94+
## Maven
9395
\`\`\`xml
9496
<dependency>
9597
<groupId>${GROUP_ID}</groupId>
@@ -98,20 +100,16 @@ jobs:
98100
</dependency>
99101
\`\`\`
100102
101-
### Gradle (Kotlin DSL)
103+
## Gradle (Kotlin DSL)
102104
\`\`\`kotlin
103105
implementation("${GROUP_ID}:${ARTIFACT_ID}:${VERSION}")
104106
\`\`\`
105107
106-
### Gradle (Groovy DSL)
108+
## Gradle (Groovy DSL)
107109
\`\`\`groovy
108110
implementation '${GROUP_ID}:${ARTIFACT_ID}:${VERSION}'
109111
\`\`\`
110112
111-
📦 [View on Maven Central](https://central.sonatype.com/artifact/${GROUP_ID}/${ARTIFACT_ID}/${VERSION})
112-
113-
---
114-
115113
EOF
116114
)
117115

.github/workflows/sdk-build.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
name: "SDK E2E Tests"
22

33
env:
4-
HUSKY: 0
5-
PYTHONUTF8: 1
64
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
75

86
on:

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,21 @@ Run `mvn install` locally, then configure the dependency in your project.
2020
<dependency>
2121
<groupId>io.github.copilot-community-sdk</groupId>
2222
<artifactId>copilot-sdk</artifactId>
23-
<version>0.1.0</version>
23+
<version>1.0.0</version>
2424
</dependency>
2525
```
2626

2727
### Gradle
2828

29+
Groovy:
30+
2931
```groovy
30-
implementation 'io.github.copilot-community-sdk:copilot-sdk:0.1.0'
32+
implementation 'io.github.copilot-community-sdk:copilot-sdk:1.0.0'
33+
```
34+
35+
Kotlin
36+
```kotlin
37+
implementation("io.github.copilot-community-sdk:copilot-sdk:1.0.0")
3138
```
3239

3340
## Quick Start
@@ -89,7 +96,7 @@ jbang jbang-example.java
8996
The `jbang-example.java` file includes the dependency declaration and can be run directly:
9097

9198
```java
92-
//DEPS com.github.copilot:copilot-sdk:0.1.0
99+
//DEPS com.github.copilot:copilot-sdk:1.0.1-SNAPSHOT
93100
```
94101

95102
## Documentation
@@ -98,18 +105,11 @@ For detailed API reference and advanced usage examples, see [DOCS.md](DOCS.md).
98105

99106
## Building and Testing
100107

101-
### Building the Project
102-
103-
```bash
104-
mvn clean compile
105-
```
106-
107-
### Running Tests
108-
109-
The tests require test resources (snapshots, harness) from the official [copilot-sdk](https://github.com/github/copilot-sdk) repository. The build automatically clones this repository during the `generate-test-resources` phase:
108+
The tests require test resources (snapshots, harness) from the official [copilot-sdk](https://github.com/github/copilot-sdk) repository.
109+
The build automatically clones this repository during the `generate-test-resources` phase:
110110

111111
```bash
112-
mvn clean test
112+
mvn clean verify
113113
```
114114

115115
The official SDK repository is cloned to `target/copilot-sdk/` and the `copilot.tests.dir` property is set to point to its `test/` folder.

0 commit comments

Comments
 (0)