Skip to content

dev

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

dev

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.rst
README.rst
 
 
build.sbt.end
build.sbt.end
 
 
plugins.sbt.end
plugins.sbt.end
 
 

README.rst

Use SBT 0.13.2 to compile. See project/build.properties.

Update Swagger UI

  • Copy dist directory from https://github.com/wordnik/swagger-ui to src/main/resources/public/xitrum as swagger-ui-<version>.
  • Modify xitrum.routing.SwaggerUiVersioned based on the index.html.
  • Remove index.html.

Update src/main/resources/META-INF/mime.types

This file is for determining content types for static files.

See:

Debug client-server data receiving and sending

I recommend Tcpdump / Wireshark, or even better Tcpflow: http://groups.google.com/group/sockjs/msg/12f28eccf1851d54

Generate API doc with graphical type hierarchy

Demo: http://xitrum-framework.github.io/api/index.html#xitrum.Action

Graphviz is required, see build.sbt.end.

Create dependency graph

Demo: http://xitrum-framework.github.io/guide/deps.html

Generate target/dependencies-compile.dot:

sbt dependency-dot

Convert dependencies-compile.dot to deps.png:

dot -Tpng dependencies-compile.dot > deps.png

See: https://github.com/jrudolph/sbt-dependency-graph.

Publish to local

While developing, you may need do local publish. Run sbt publish-local. Alternatively you can run sbt then from SBT command prompt run + publish-local.

To delete the local publish:

$ find ~/.ivy2 -name *xitrum* -exec rm -rf {} \;

Publish to Sonatype

Before releasing a new Xitrum version, run sbt xitrum-package on project xitrum-new and xitrum-demos, then see directory target/xitrum/lib to see if there's any wrong with the versions of .jar files.

See: https://github.com/sbt/sbt.github.com/blob/gen-master/src/jekyll/using_sonatype.md

Create ~/.sbt/0.13/sonatype.sbt (for SBT 0.12: ~/.sbt/sonatype.sbt) file:

credentials += Credentials("Sonatype Nexus Repository Manager",
                           "oss.sonatype.org",
                           "<your username>",
                           "<your password>")

Then:

  1. Copy content of
    dev/build.sbt.end to the end of build.sbt dev/plugins.sbt.end to the end of project/plugins.sbt
  2. Run sbt publish-signed. Alternatively you can run sbt then from SBT command prompt run + publish-signed.
  3. Login at https://oss.sonatype.org/ and from "Staging Repositories" select the newly published item, click "Close" then "Release".

Update related projects

After each new version release, please update these projects to use that new Xitrum version:

Also update gh-pages branch of Xitrum and Xitrum guide.

When a new SBT generation is released, also update xitrum-sbt-plugin.