Updating the NationalMap Catalogue

This page describes how to update the NationalMap catalogue without releasing a new version of the application itself. If you're releasing a new version of the app, see the Releasing NationalMap instructions instead.

Configure your Amazon Web Services credentials

You need:

• Access to the nationalmap account on AWS.
• Appropriate AWS credentials configured in a nationalmap profile so that you can upload files to S3 and deploy a CloudFormation stack.

Preparing the catalogue

• Merge any open pull requests that you would like in this catalogue release.
• Edit CHANGES.md. For out-of-band catalogue releases, the section name should be along the line of [App release date]-updated-[Catalogue release date], e.g. 2018-04-16-updated-2018-05-14. If you're not sure of the app release date, go to https://nationalmap.gov.au/config.json and look at the initializeUrls. For example, if the URL is "/proxy/_60s/http://static.nationalmap.nicta.com.au/init/2018-04-16.json", the app release date is 2018-04-16. The catalogue release date is usually today's date.
• Build the catalog by running gulp. Verify any changes, and commit and push them.

Publishing the catalogue to S3

• Tag the catalog release using the same scheme you used in CHANGES.md, e.g. git tag -a 2018-04-16-updated-2018-05-14 -m '2018-04-16-updated-2018-05-14 release'.
• Push the catalog to S3 as a separate file by running ./publish.sh 2018-04-16-updated-2018-05-14. Use your tag name, of course.
• Test the new catalog by visiting e.g. https://nationalmap.gov.au/#clean&http://static.nationalmap.nicta.com.au/init/2018-04-16-updated-2018-05-14.json.

Making the new catalogue official

If everything looks good above, you can make that catalogue the official one by overwriting the JSON file currently being used by NationalMap:

./publish.sh 2018-04-16

Where 2018-04-16 is the version of the catalog file specified in https://nationalmap.gov.au/config.json.