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 to compile. See project/build.properties.

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

This file is for determining content types for static files.

See:

On Mac, can use opendiff GUI tool to compare:

opendiff file1 file2

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 dependencyDot

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.

To do local publish for the scalaVersion specified in build.sbt:

sbt publishLocal

To do local publish for all the crossScalaVersions:

sbt "+ publishLocal"

To delete the local publish:

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

Publish to Sonatype

Before releasing a new Xitrum version, run sbt xitrumPackage 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/1.0/sonatype.sbt file:

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

Then:

  1. Temporarily remove -SNAPSHOT from the version in build.sbt. Also comment out publishArtifact in (Compile, packageDoc) := false in build.sbt.
  2. Copy
    dev/build.sbt.end to the end of build.sbt, and dev/plugins.sbt.end to the end of project/plugins.sbt
  3. Run sbt "+ publishSigned".
  4. Login at https://oss.sonatype.org/ and from "Staging Repositories" select the newly published item, click "Close" then "Release".

On Mac, if you see error Cannot run program "gpg": error=2, No such file or directory, install gnupg:

brew install gnupg

Tag the newly published version

See: https://github.com/xitrum-framework/xitrum/tags

To tag:

git tag --list
git tag <new version number>
git push origin <new version number>

Update related projects

Each time, after publishing a new Xitrum version (above), please update these projects to use that new version:

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

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

Announce the newly published version

Post to a new thread about the new version to: https://groups.google.com/g/xitrum-framework