Android Library Release Script

Release any Android library with this one simple trick DevOps won't tell you about.

Prerequisites

brew install maven
brew install holgerbrandl/tap/kscript
brew install hub

Also, the project that you want to run the script on should have:

1. CHANGELOG.md
   • Version headings should start with ##
2. gradle.properties
   • Should contain a VERSION_NAME property (e.g VERSION_NAME=1.0.0)
3. There should be an uploadArchives task in Gradle or you can use --publish-task-name parameter to pass your custom task name

Usage

In order for the script to work, you have to run it inside the project you want to release.

$ kscript https://raw.githubusercontent.com/crunchyroll/android-library-release-script/master/src/main/kotlin/Release.kt --help

usage: [-h] [--dry-run] [--ticket TICKET] [--changelog CHANGELOG]
       [--tag-prefix TAG_PREFIX] [--no-tag-prefix]

optional arguments:
  -h, --help                show this help message and exit

  --dry-run                 Run the script with all actions disabled. Use this
                            to understand which actions would have been
                            executed.

  --ticket TICKET           Ticket number to use when creating the version
                            bump PR. Default is GUNDROID-88.

  --changelog CHANGELOG     Changelog file to modify

  --tag-prefix TAG_PREFIX   Version prefix to use for tag creation

  --no-tag-prefix           Do not add any prefix to the version tag
  
  --labels                  Labels to be added to the Version Bump Pull Request
  
  --publish-task-name       Maven publish task name

Development

Run ./gradlew build to compile the script and run all checks.

Deployment

The script itself doesn't have to be deployed. Anyone can reference it directly from the master tree.

License

Copyright 2019 Ellation, Inc. 

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.