FOR ARCHIVAL PURPOSES ONLY

The information in this wiki hasn't been maintained for a good while. Some of the projects described have since been deprecated.

In particular, the "Ushahidi Platform v3.x" section contains information that is often misleading. Many details about this version of Platform have changed since.

This website is an extraction of the original Ushahidi wiki into a static form. Because of that, functions like logging in, commenting or searching will not work.

For more documentation, please refer to https://docs.ushahidi.com

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Create release candidate builds, distribute to testers

Generating build files

For the API

To create a build, run:

bin/release v3.0.0-beta.1

This will create .tar.gz files in build/

For the client

To create a build, run:

...

Tag the release

Releases should be generated from a tag regardless if they are a release candidate, alpha, beta, or final release.

For the client: bump first

gulp bump --type prerelease

This will create .tar.gz files in build/

...

git add bower.json package.json
git commit

This will bump the version in bower.json and package.json.
So you need to commit, tag and push afterwards.

Tag the release

Releases should be generated from a tag regardless if they are a release candidate, alpha, beta, or final release.

Both client and API

Create a tag in git following semantic versioning by running the following:

git tag -sas "v3.0.0-beta.1"

Note: -s creates a GPG signed tag. -a annotates the tag.
Use the changelog as the tag message.

Once you push the tag Travis-CI will generate build files and create a github release.

GPG Signatures

Builds should be distributed with a gpg signature (.asc) file. To generate signatures runDownload the generate builds from github releases and check the match the tagged code.
Generate signatures by running:

gpg -ab Ushahidi-Platform-v3.0.0-beta.1.tar.gz 

These signature should be uploaded to github releases and linked on the download page

If you need to manually generate build files

For the API

To create a build, run:

bin/release v3.0.0-beta.1

This will create .tar.gz files in build/

For the client

To create a build, run:

gulp release --type prerelease

This will create .tar.gz files in build/

Note: the release script will bump the version in bower.json and package.json.
So you need to commit, tag and push afterwards.

Draft release announcement

...