Application: publisher

Publishes mainstream content on GOV.UK

• GitHub: publisher
• Ownership: #govuk-platform-health
• Hosting: AWS, on the backend machine class
• Continuously deployed?: Yes
• Rake tasks: Run a Rake task on Integration, Staging or ⚠️ Production ⚠️
• Links:
  • Sentry (error tracking)
  • Puppet configuration
  • Deploy scripts
  • Deployment dashboard
  • Publishing E2E scenarios (warning: not all apps have E2E tests)

Imported documents

• Fact Checking
• /arch
• Decision record: Forking frontend components from GOV.UK Frontend
• Decision record: Rendering Service Sign In pages using Government Frontend
• Decision record: Why “Service sign in” is its own format
• Decision record: Why “Service sign in” pages are created using rake tasks
• Decision record: Why Service sign in pages aren’t linked to from transaction pages using a content id

Example pages published by publisher

• Report a COVID-19 rapid lateral flow test result
• Sign in to your Universal Credit account
• Fill in your passenger locator form
• HMRC services: sign in or register
• Get a free PCR test to check if you have coronavirus (COVID-19)
• Check the MOT history of a vehicle
• Order coronavirus (COVID-19) rapid lateral flow tests
• Tax your vehicle
• Check if a vehicle is taxed
• Get information about a company

README

Publisher is sometimes referred to as “mainstream publisher”.

This application depends on imminence to provide geographical search tools.

Live examples

• Answer
• Completed transaction
• Guide
• Help page
• Licence
• Local transactions
• Place
• Service sign in
• Simple smart answer
• Transaction

Retired formats

• Campaign
• Programme
• Video

Removed formats

• Business Support - used to be retired, and the documents remained visible, now they’re fully removed as editions and no longer visible in the app (although the artefacts do still exist). They have been fully migrated to specialist-publisher.

Nomenclature

• Artefact: a document on GOV.UK.

Technical documentation

This is a 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.

Testing

The default rake task runs all the tests:

bundle exec rake

State machine

Maps out the transitions between states for the Edition class. These transitions are defined in the workflow module. A diagram of the current state machine can be seen here: state machine diagram. The diagram can be (re)generated using the state_machines-graphviz gem, by doing:

bundle exec rake state_machines:draw CLASS=Edition TARGET=docs

This will generate a diagram in the docs/state_machines folder.

Further documentation

• Fact Checking

Working with Service Sign In pages

These pages do not have an admin interface and are instead managed through rake tasks.

See the README for more details.

Licence

MIT License