Update CI to publish Java SDK (#16)

Author: dannysheridan

.github/workflows/ci.yml

@@ -6,7 +6,8 @@ jobs:
   fern-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repo
+        uses: actions/checkout@v3
 
       - name: Install Fern
         run:  npm install -g fern-api
@@ -19,16 +20,19 @@ jobs:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repo
+        uses: actions/checkout@v3
 
       - name: Setup node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
 
-      - name: Download fern
+      - name: Download Fern
         run: npm install -g fern-api
 
       - name: Release SDKs
         env:
           FERN_NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }}
-        run: fern release ${{github.ref_name}} --log-level debug
-        
+          FERN_MAVEN_USERNAME: ${{ secrets.FERN_MAVEN_USERNAME }}
+          FERN_MAVEN_TOKEN: ${{ secrets.FERN_MAVEN_TOKEN }}
+        run: fern release ${{ github.ref_name }} --log-level debug
+        

README.md

@@ -1,51 +1,37 @@
 # Raven API
 
-Tagging a release on this repository will generate and release new SDKs. Currently included SDKs:
+Tagging a release on this repository will update the:
 
-- JavaScript/TypeScript SDK: https://github.com/ravenappdev/raven-node
-
-## [tl;dr] How does it work?
-
-1. When you tag a release, Fern generates SDKs based on the Fern API Definition in this repo.
-1. Each generated SDK is pushed to its own GitHub repo.
-1. Each SDK's repo has GitHub actions that compile the code and publish the package to its respective registry.
+- [TypeScript SDK Github Repo](https://github.com/ravenappdev/raven-node)
+- [Java SDK Github Repo](https://github.com/ravenappdev/raven-java)
+- _More SDKs to come..._
 
 ## What is in this repository?
 
 This repository contains
 
-- Raven's [Fern API Definition](./fern/api/definition/)
-- Enabled generators ([generators.yml](./fern/api/generators.yml))
+- Raven's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
+- Generators (see [generators.yml](./fern/api/generators.yml))
 
 ## What is in the API Definition?
 
-The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as [device.yml](fern/api/definition/device.yml) and [event.yml](fern/api/definition/event.yml).
+The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as [device.yml](fern/api/definition/device.yml).
 
 In order to make sure that the definition is valid, you can use the Fern CLI.
 
 ```bash
-npm install -g fern-api
-fern check
+npm install -g fern-api # Installs CLI
+fern check # Checks if the definition is valid
 ```
 
 ## What are Generators?
 
-A generator reads in your API Definition and outputs files. The generated files are then pushed to a GitHub repo.
-
-The list of enabled generators is in [generators.yml](./fern/api/generators.yml).
-
-For example, the TypeScript generator creates the TypeScript SDK. Fern pushes the generated files to [raven-node](https://github.com/ravenappdev/raven-node) and tags a release on that repo. This triggers a GitHub action on the [raven-node](https://github.com/ravenappdev/raven-node) repo, which compiles and publishes the package to npm.
+Generators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/api/generators.yml).
 
-The generators are invoked by running `fern release`. When you tag a release on this repo, there's a [GitHub action](.github/workflows/ci.yml#L31) that runs `fern release`.
-
-## How do I make changes to the API?
-
-1. Clone this repo
-1. Install fern: `npm install -g fern-api`
-1. Edit the [API Definition](fern/api/definition) 
-1. You can run `fern check` to check for issues
-1. Make a PR to this repo
-1. If checks pass, merge the PR in
-1. When you're ready to release new versions of your SDKs, just tag a release on this repo
+To trigger the generators run:
 
+```bash
+fern release <version>
+```
 
+This command currently runs in a GitHub workflow (see [ci.yml](.github/workflows/ci.yml#L32))

fern/api/definition/api.yml

@@ -3,4 +3,6 @@ auth: AuthKey
 auth-schemes:
   AuthKey:
     header: Authorization
-# origin: https://api.ravenapp.dev
+environments:
+  Prod: https://api.ravenapp.dev
+default-environment: Prod

fern/api/definition/ids.yml

@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json
+
 types:
   AppId: string
   UserId: string

fern/api/generators.yml

@@ -1,9 +1,18 @@
 release:
   - name: fernapi/fern-typescript-sdk
-    version: 0.0.209
+    version: 0.0.219
     publishing:
       npm:
-        package-name: "@fern-api/raven" # TODO: should be published under Raven's NPM org
+        package-name: '@fern-api/raven' # TODO: should be published under Raven's NPM org
         token: ${FERN_NPM_TOKEN} # TODO: should use Raven's NPM Token
     github:
-      repository: fern-api/raven-node
+      repository: ravenappdev/raven-node
+  - name: fernapi/fern-java-sdk
+    version: 0.0.121
+    publishing:
+      maven:
+        coordinate: io.github.fern-api:raven
+        username: ${FERN_MAVEN_USERNAME} # TODO: should be published under Raven's Maven account
+        password: ${FERN_MAVEN_TOKEN}
+    github:
+      repository: ravenappdev/raven-java

fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "raven",
-  "version": "0.0.214"
+  "version": "0.0.221"
 }