Rights-app

This is the application that serves the vocabulary terms in the rightsstatements.org data model. For background information, see the Requirements for the Technical Infrastructure for Standardized International Rights Statements white paper.

Setup

Clone this repository

$ git clone git@github.com:rightsstatements/rights-app.git && cd rights-app

rights-app is built with Play Framework 2.4.3 so you need to make sure to have the Java 8 JDK and sbt installed. Then

$ sbt run

and visit http://localhost:9000.

Implementing translations

Transifex is used to carry out translations of the app. The relevant resource is tagged with the category rights-app. Please get in touch with the maintainers to add a new language to the project.

To incorporate updates or new translations, install tx. Unicode-only characters in the translated strings will need to be converted to ASCII for the application to support them. Also, single quotes will need to be escaped. For convenience, the updateI18n.sh script performs this functionality for you. Arguments provided to the script are passed to tx pull. To update every language, you can execute

$ ./updateI18n.sh -f -a

and to add or update specific languages, you can separate them with commas, like so:

$ ./updateI18n.sh -f -l fr,it

If a new translation has been added, enable it by editing the languages.available key in conf/application.conf.

The new version needs to be tagged with git so that it gets recognized as a new release, using a tag that starts with v (e.g. v1.2.7).

See also notes on implementing translations for the data model and the website for more information.

🚀 Automated Release & Deployment Process

This repository uses automated workflows to manage deployments. Code deployment to target environments is triggered upon creation of new Git Releases.

⚠️ Important: Deletion Behavior

• Automatic Roll-Forward/Fall-Back: If a currently active Git Release is deleted, the system will automatically trigger a deployment for whichever release becomes the next available/valid version. Please exercise extreme caution when deleting releases in this repository.

---

⚙️ How it Works

The deployment pipeline bridges Git and Jenkins using webhook automation through the following steps:

[ Git Release Created ]
│
▼
[ Webhook Event Fired ]
│
▼
[ Jenkins Job Triggered ] ──► (Passes Release Tag Info)
│
▼
[ Automated Deployment ]  ──► (Checkouts latest tag, Builds & Deploys)

1. Create Release A developer creates and publishes a new Release in Git with a specific version tag (e.g., v1.2.0).

2. Webhook Trigger The Git platform detects the release creation event and immediately fires an automated webhook payload.

3. Jenkins Execution The webhook securely triggers our dedicated Jenkins deployment job, passing along the specific release tag information.

4. Automated Deployment Jenkins checkouts the latest release code matching that tag, builds the required software artifacts, and automatically deploys them to the target environment.