Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ember.carr.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
Add the repository

The Ember API is published to GitHub Packages. You’ll need to authenticate with a GitHub personal access token that has the read:packages scope. 
repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/lukecarr/ember")
        credentials {
            username = providers.gradleProperty("gpr.user").orNull
                ?: System.getenv("GITHUB_ACTOR")
            password = providers.gradleProperty("gpr.token").orNull
                ?: System.getenv("GITHUB_TOKEN")
        }
    }
}

​
Add the dependency

dependencies {
    compileOnly("sh.carr.ember:ember-api:0.1.0-alpha.1")
}
Use compileOnly or provided. The API is bundled inside the running Ember plugin, so you don’t want a second copy inside your own jar.

​
Hello, Ember

Read the running Ember version: 
import sh.carr.ember.Ember

val emberVersion = Ember.instance.version
logger.info("Running Ember $emberVersion")

​
Declare Ember as a dependency

Add Ember as a hard dependency of your plugin so it loads after Ember and Ember.instance is always available. 
dependencies:
  server:
    Ember:
      load: BEFORE
      required: true