Skip to content

Commit bfce409

Browse files
docs: Update Readme for migrating sdk-gen to main (box/box-codegen#889) (#1585)
1 parent 67cde94 commit bfce409

File tree

7 files changed

+77
-10
lines changed

7 files changed

+77
-10
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "35c5d34", "specHash": "e7ce024", "version": "10.2.0" }
1+
{ "engineHash": "4147cc3", "specHash": "e7ce024", "version": "10.2.0" }

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: SDK documentation
4-
url: https://github.com/box/box-java-sdk/tree/sdk-gen/docs
4+
url: https://github.com/box/box-java-sdk/tree/main/docs
55
about: Before creating an issue, I have checked that the SDK documentation doesn't solve my issue.
66
- name: API documentation
77
url: https://developer.box.com/docs
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Build and Test daily
2+
on:
3+
schedule:
4+
- cron: '20 1 * * 1-5'
5+
jobs:
6+
build-and-test:
7+
runs-on: ubuntu-latest
8+
strategy:
9+
max-parallel: 1
10+
matrix:
11+
distribution: ['zulu', 'temurin']
12+
java: ['8', '17']
13+
name: Java ${{ matrix.java }} (${{ matrix.distribution }})
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v4
17+
with:
18+
ref: main
19+
- name: Setup Java
20+
uses: actions/setup-java@v4
21+
with:
22+
distribution: ${{ matrix.distribution }}
23+
java-version: ${{ matrix.java }}
24+
cache: 'gradle'
25+
- name: All Tests
26+
env:
27+
JWT_CONFIG_BASE_64: ${{ secrets.JWT_CONFIG_BASE_64 }}
28+
ADMIN_USER_ID: ${{ secrets.ADMIN_USER_ID }}
29+
CLIENT_ID: ${{ secrets.CLIENT_ID }}
30+
CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
31+
USER_ID: ${{ secrets.USER_ID }}
32+
ENTERPRISE_ID: ${{ secrets.ENTERPRISE_ID }}
33+
BOX_FILE_REQUEST_ID: ${{ secrets.BOX_FILE_REQUEST_ID }}
34+
BOX_EXTERNAL_USER_EMAIL: ${{ secrets.BOX_EXTERNAL_USER_EMAIL }}
35+
BOX_EXTERNAL_USER_ID: ${{ secrets.BOX_EXTERNAL_USER_ID }}
36+
APP_ITEM_ASSOCIATION_FILE_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FILE_ID }}
37+
APP_ITEM_ASSOCIATION_FOLDER_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FOLDER_ID }}
38+
WORKFLOW_FOLDER_ID: ${{ secrets.WORKFLOW_FOLDER_ID }}
39+
APP_ITEM_SHARED_LINK: ${{ secrets.APP_ITEM_SHARED_LINK }}
40+
SLACK_AUTOMATION_USER_ID: ${{ secrets.SLACK_AUTOMATION_USER_ID }}
41+
SLACK_ORG_ID: ${{ secrets.SLACK_ORG_ID }}
42+
SLACK_PARTNER_ITEM_ID: ${{ secrets.SLACK_PARTNER_ITEM_ID }}
43+
run: ./gradlew check --stacktrace
44+
- name: Coverage
45+
env:
46+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47+
run: ./gradlew jacocoTestReport coverallsJacoco
48+
notify:
49+
name: Send Slack Notification
50+
runs-on: ubuntu-latest
51+
needs: [build-and-test]
52+
if: always()
53+
steps:
54+
- name: Send Slack Notification
55+
env:
56+
SLACK_WEBHOOK_TEST_NOTIFICATION_URL: ${{ secrets.SLACK_WEBHOOK_TEST_NOTIFICATION_URL }}
57+
BUILD_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
58+
run: |
59+
if [ "${{ needs.build-and-test.result }}" != "success" ]; then
60+
STATUS="Failure ❌"
61+
else
62+
STATUS="Success ✅"
63+
fi
64+
65+
curl -X POST -H "Content-Type: application/json" \
66+
--data "{\"text\":\"<${BUILD_URL}|Daily Tests Job> in *${GITHUB_REPOSITORY}* finished with status: ${STATUS}\"}" \
67+
"$SLACK_WEBHOOK_TEST_NOTIFICATION_URL"

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: build
22
on:
33
pull_request:
44
branches:
5-
- sdk-gen
5+
- main
66

77
permissions:
88
contents: read

.github/workflows/semantic-pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
- edited
88
- synchronize
99
branches:
10-
- sdk-gen
10+
- main
1111

1212
permissions:
1313
contents: read

.github/workflows/spell-check-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
pull_request_target:
44
types: [opened, synchronize, edited]
55
branches:
6-
- sdk-gen
6+
- main
77

88
permissions:
99
contents: read

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
# Box Java SDK v10
66

77
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
8-
![build](https://github.com/box/box-java-sdk/actions/workflows/build.yml/badge.svg?branch=sdk-gen)
8+
![build](https://github.com/box/box-java-sdk/actions/workflows/build.yml/badge.svg?branch=main)
99
![Maven Central Version](https://img.shields.io/maven-central/v/com.box/box-java-sdk)
1010
![Platform](https://img.shields.io/badge/java-%3E%3D8-blue)
11-
[![Coverage](https://coveralls.io/repos/github/box/box-java-sdk/badge.svg?branch=sdk-gen)](https://coveralls.io/github/box/box-java-sdk-gen?branch=sdk-gen)
11+
[![Coverage](https://coveralls.io/repos/github/box/box-java-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-java-sdk-gen?branch=main)
1212

1313
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1414
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -69,7 +69,7 @@ Version v5 is intended for:
6969
## Version v10
7070

7171
Starting with v10, the SDK is built entirely on the generated `com.box.sdkgen` package, which fully and exclusively replaces the old `com.box.sdk` package.
72-
The codebase for v10 of the Box Java SDK is currently available on the [sdk-gen](https://github.com/box/box-java-sdk/tree/sdk-gen) branch.
72+
The codebase for v10 of the Box Java SDK is currently available on the [main](https://github.com/box/box-java-sdk/tree/main) branch.
7373

7474
Version v10 is intended for:
7575

@@ -80,8 +80,8 @@ Version v10 is intended for:
8080

8181
| Scenario | Recommended Version | Example gradle dependency |
8282
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ----------------------------- |
83-
| Creating a new application | Use [v10](https://github.com/box/box-java-sdk/tree/sdk-gen) | `com.box:box-java-sdk:10.0.0` |
84-
| App using [box-java-sdk-gen](https://central.sonatype.com/artifact/com.box/box-java-sdk-gen) artifact | Migrate to [v10](https://github.com/box/box-java-sdk/tree/sdk-gen) | `com.box:box-java-sdk:10.0.0` |
83+
| Creating a new application | Use [v10](https://github.com/box/box-java-sdk/tree/main) | `com.box:box-java-sdk:10.0.0` |
84+
| App using [box-java-sdk-gen](https://central.sonatype.com/artifact/com.box/box-java-sdk-gen) artifact | Migrate to [v10](https://github.com/box/box-java-sdk/tree/main) | `com.box:box-java-sdk:10.0.0` |
8585
| App using both [box-java-sdk-gen](https://central.sonatype.com/artifact/com.box/box-java-sdk-gen) and [box-java-sdk](https://central.sonatype.com/artifact/com.box/box-java-sdk) artifacts | Upgrade to [v5](https://github.com/box/box-java-sdk/tree/combined-sdk) | `com.box:box-java-sdk:5.0.0` |
8686
| App using v4 of [box-java-sdk](https://central.sonatype.com/artifact/com.box/box-java-sdk) artifact | Upgrade to [v5](https://github.com/box/box-java-sdk/tree/combined-sdk) | `com.box:box-java-sdk:5.0.0` |
8787

0 commit comments

Comments
 (0)