From fda95e92401943aca1e48220bf9964d825a1d2b8 Mon Sep 17 00:00:00 2001 From: Kazuhiro Sera Date: Mon, 19 Jan 2015 12:38:01 +0900 Subject: [PATCH] Add maintainers guide --- maintainers-guide.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 maintainers-guide.md diff --git a/maintainers-guide.md b/maintainers-guide.md new file mode 100644 index 00000000..71c1e523 --- /dev/null +++ b/maintainers-guide.md @@ -0,0 +1,35 @@ +## Octoparts Maintainers' Guide + +### Versioning Policy + +``` +"{server-major}.{server-minor}.{client-minor}" +``` + +When the "{client-minor}" is zero, version should be "{server-major}.{server-minor}". + +### Release + +#### Required + +- Sonatype release account +- $HOME/.sbt/0.13/sonatype.sbt + +``` scala +credentials += Credentials("Sonatype Nexus Repository Manager", "oss.sonatype.org", "xxx", "yyy") +``` + +- $HOME/.sbt/0.13/plugins/gpg.sbt + +```scala +// Use latest version +addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0") +``` + +#### Operations + +- Run `git flow release start/finish "{full-version}"` +- Run `./scripts/publish_libs.sh` +- Use `sbt sonatypeRelease` from `sbt-sonatype` plugin or access sonatype console (https://oss.sonatype.org/) +- Set version as "{next-version}-SNAPSHOT" on develop branch +