diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..bc72db1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,26 @@ +# http://www.scala-sbt.org/0.13/docs/Travis-CI-with-sbt.html +language: scala +scala: + - 2.10.6 +jdk: + - oraclejdk8 +script: + - sbt ++$TRAVIS_SCALA_VERSION compile + # Tricks to avoid unnecessary cache updates + - find $HOME/.sbt -name "*.lock" | xargs rm + - find $HOME/.ivy2 -name "ivydata-*.properties" | xargs rm +notifications: + email: false + webhooks: + urls: + - https://webhooks.gitter.im/e/67562f0726ed2388330c + on_success: change # options: [always|never|change] default: always + on_failure: always # options: [always|never|change] default: always + on_start: false +# Use container-based infrastructure +sudo: false +# These directories are cached to S3 at the end of the build +cache: + directories: + - $HOME/.ivy2/cache + - $HOME/.sbt/boot/ diff --git a/Readme.md b/Readme.md index 7baab62..2628592 100644 --- a/Readme.md +++ b/Readme.md @@ -1,15 +1,12 @@ ## Sbt Github release plugin -This is a simple sbt-plugin for creating [Github releases](https://github.com/blog/1547-release-your-software) with proper release notes and optional artifact uploading using [kohsuke/github-api](https://github.com/kohsuke/github-api) library. +[![](https://travis-ci.org/ohnosequences/sbt-github-release.svg?branch=master)](https://travis-ci.org/ohnosequences/sbt-github-release) +[![](https://img.shields.io/codacy/811d530bf7d548ed8bcbb506f7490bef.svg)](https://www.codacy.com/app/ohnosequences/sbt-github-release) +[![](http://github-release-version.herokuapp.com/github/ohnosequences/sbsbt-github-release/release.svg)](https://github.com/ohnosequences/sbt-github-release/releases/latest) +[![](https://img.shields.io/badge/license-AGPLv3-blue.svg)](https://tldrlegal.com/license/gnu-affero-general-public-license-v3-%28agpl-3.0%29) +[![](https://img.shields.io/badge/contact-gitter_chat-dd1054.svg)](https://gitter.im/ohnosequences/sbt-github-release) -It can be useful as a part of [automated release process](https://github.com/sbt/sbt-release). - - -### Features - -* Publishes release notes -* Optionally uploads jar assets -* Exposes all available parameters of the Github releases API +This is a simple sbt-plugin for creating [Github releases](https://github.com/blog/1547-release-your-software) with proper release notes and optional artifact uploading. It can be useful as a part of an automated release process. ## Usage @@ -56,7 +53,7 @@ GithubRelease.draft := true You set which files to attach to the release using the `releaseAssets` setting. -Note, that Github requires to set the media ([MIME]) type of each asset. You can customize which media types will be used through the `mediaTypesMap` setting. Github documentation refers to [IANA](https://www.iana.org/assignments/media-types/media-types.xhtml) for the list of accepted types. +Note, that Github requires to set the media ([MIME](https://en.wikipedia.org/wiki/Media_type)) type of each asset. You can customize which media types will be used through the `mediaTypesMap` setting. Github documentation refers to [IANA](https://www.iana.org/assignments/media-types/media-types.xhtml) for the list of accepted types. By default `mediaTypesMap` is set to the default Java [`MimetypesFileTypeMap`](https://docs.oracle.com/javase/8/docs/api/javax/activation/MimetypesFileTypeMap.html) (with some modifications) which looks for the MIME types files in various places in your system. If you don't have any, you can download [one](http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/conf/mime.types?view=co) and save it as `~/.mime.types`. If you are uploading only `.jar` and `.pom` files, you don't need to do anything. @@ -79,16 +76,8 @@ oauth = 623454b0sd3645bdfdes541dd1fdg34504a8cXXX But you don't need to create this file manually — when running `releaseOnGithub`, plugin checks it and if there is no valid token, asks you to go and create one and then saves it. - +