Skip to content

Latest commit

 

History

History
124 lines (91 loc) · 4.06 KB

README.md

File metadata and controls

124 lines (91 loc) · 4.06 KB
Raw

OneSky Gradle Plugin

Plugin for downloading and uploading translations from OneSky

Installation

app/build.gradle.kts

plugins {
    id("co.brainly.onesky") version "1.5.0"
}

// ...

configure<OneSkyPluginExtension> {
    apiKey = "your-api-key"
    apiSecret = "your-api-secret"
    projectId = <your_project_id>
    
    // list of files to sync in your src/main/res/values directory, 
    // e.g.: listOf("strings.xml", "plurals.xml")
    sourceStringFiles = emptyList()
    
    // has src/main/res/ as a default value,    
    // can be overriden with your custom path (optional)
    sourcePath = "path-to-your-string-values-directory"
    
    // prefix set for translation files located in different Gradle modules
    // which share the same OneSky project
    // (optional, required for multi-module support)
    moduleName = "avatar-picker"

    // Determines if the plugin should download & replace the base language or not.
    // defaults to false
    downloadBaseLanguage = false
}

Features

Task Description
translationsProgress Displays translations progress for all languages
downloadTranslations Downloads all of available translations (including not finished ones)
uploadTranslations Uploads base translation files

Add -Pdeprecate-strings if you would like to deprecate strings on OneSky which are not present in sourceStringFiles.

# deprecates removed strings on OneSky
./gradlew sample:uploadTranslations -Pdeprecate-strings

Multi-module support

If you have a multi-module project and would like to:

  • use single OneSky project for all of them
  • AND keep translation files in their respective modules

your choice is to either:

  • name every strings.xml file differently for every module, which seems tedious
  • OR use moduleName property in OneSkyPluginExtension

moduleName property will automatically prefix your string files so they do not overlap on OneSky.

Example:

// project-dir/my-feature-module/build.gradle.kts

configure<OneSkyPluginExtension> {
    moduleName = "my-feature"
}

will result in uploading my-feature-strings.xml to OneSky, so on next sync, my-feature-strings.xml will be downloaded, containing only translations for a given module.

Releasing

See the release instructions here.

Development

# run tests
./gradlew test

# publish locally
./gradlew clean plugin:build plugin:publishToMavenLocal

# run a sample
./gradlew sample:translationsProgress

License

MIT License

Copyright (c) 2021 Brainly, Inc

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.