Application: content-publisher

Publishing application for GOV.UK

• GitHub: content-publisher
• Ownership: #govuk-whitehall-experience-tech
• Category: Publishing apps
• Links:
  • content-publisher.publishing.service.gov.uk
  • Sentry (error tracking)
  • App dashboard: request rates, errors, durations
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (content-publisher)

Example pages published by content-publisher

• State Pension Age Review published
• Wrongly-convicted no longer face being ‘charged’ for saved living expenses
• Legal age of marriage in England and Wales rises to 18
• Court judgments made accessible to all at The National Archives
• PHE issues advice to people travelling to Egypt
• Discounted homes for key workers and local residents as flagship First Homes scheme launches
• Britain’s first ‘smart’ prison to drive down crime
• New 95% mortgage scheme launches
• New non-fatal strangulation offence comes into force
• Trolls who encourage serious self-harm to face jail

README

NOTE: This project is deprecated and is planned to be retired.

---

A unified publishing application for content on GOV.UK

Nomenclature

• Content - Some text (and related fields) a user wants to publish
• Revision - A version of a piece of content in a particular locale
• Edition - A revision that is in the Publishing API
• Document - All revisions of a piece of content in a particular locale

Technical documentation

This is a Ruby on Rails application, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Use GOV.UK Docker to run any commands that follow.

Before running the app

The first time you run this application for development, enable debug and pre_release_features permissions:

bundle exec rake development_permissions

To enable them for your GOV.UK account add them to your account in Signon.

Running the test suite

Note: You will need to checkout govuk-helm-charts into your govuk repository in order to have local tests passing.

bundle exec rake

To run JavaScript tests (only):

# run JS tests in browser
yarn run jasmine:browser

run JS tests on command line
yarn run jasmine:ci

Our test environment is setup to render ‘real’ error pages, instead of raising an exception. This can make it hard to debug a test failure, as the actual error won’t appear in the test output. Instead, you can see it in log/test.log.

Further documentation

• Approach to analytics
• Editing change note history
• History mode
• Importing documents from Whitehall
• Removing documents
• Scheduled publishing
• Testing strategy
• User permissions

Licence

MIT License