GitSwarm 2016.3-2 Documentation


Rake tasks for developers

Setup db with developer seeds

Note that if your db user does not have advanced privileges you must create the db manually before running this command.

bundle exec rake setup

The setup task is a alias for gitlab:setup. This tasks calls db:reset to create the database, calls add_limits_mysql that adds limits to the database schema in case of a MySQL database and finally it calls db:seed_fu to seed the database. Note: db:setup calls db:seed but this does nothing.

Run tests

This runs all test suites present in GitSwarm.

bundle exec rake test

Generate searchable docs for source code

You can find results under the doc/code directory.

bundle exec rake gitswarm:generate_docs

Generate API documentation for project services (e.g. Slack)

bundle exec rake services:doc

Updating Emoji Digests

To update the Emoji digests file (used for Emoji autocomplete) you must run the following:

bundle exec rake gemojione:digests

This will update the file fixtures/emojis/digests.json based on the currently available Emoji.

Emoji Sprites

Generating a sprite file containing all the Emoji can be done by running:

bundle exec rake gemojione:sprite

If new emoji are added, the spritesheet may change size. To compensate for such changes, first generate the emoji.png spritesheet with the above Rake task, then check the dimensions of the new spritesheet and update the SPRITESHEET_WIDTH and SPRITESHEET_HEIGHT constants accordingly.