Symbol Library release checklist

This is a rough overview for creating new releases to the symbol library, and updating dependencies that reference the symbol library, specifically NPMap.js and NPMap Builder.

• Create an issue for each bug fix, symbol addition, symbol removal, or other modification.

• Tie issue to a milestone, named for the release it will be a part of.

  • Reminders:
    • Bug fix releases add a number to the last digit (0.0.x)
    • New symbol releases: middle digit (0.x.0)
    • Major change releases: first digit (x.0.0) (Symbols removed, sprite scheme changed, among others)
    • Consistently use all three digits in each release (ex., "2.3.0", not "2.3")

• For new symbols

  • Prepare artwork in .svg format. At this stage, create just the black variants at the three sizes. See Symbol Library specifications for more information.
  • Send draft vector artwork to HFC for review (Jake C. can provide you with contact information). PDFs or simple webpages are both possibilities.
  • Make revisions as necessary; iterate until all parties are satisfied with the artwork.
  • Create white variants from black artwork. For large numbers of symbols, you can bulk edit SVGs using a text editor like Sublime or Atom, and rename them using commands in Terminal.
  • Add .svg artwork standalone directory, and close issues.
  • For symbols used in mobile apps:
    • Open each white 22px variant in Illustrator.
    • For each symbol, Export for Screens (Cmd + Option + E) and save as .png, transparency maintained, at three scale formats (1x, 2x, and 3x)
    • Naming convention for mobile symbols: airport.png, airport@2x.png, airport@3x.png
    • Upload PNGs to the NPMap production server, under the directory projects/places-mobile/icons

• Update repository

  • Update package.json with new version number
  • Update the npmap-symbol-library.json file in the www/standalone directory. A separate entry for each piece of artwork (every size and both black and white variants for those sizes) needs to be represented in the file to be rendered properly. Ignore the www/builder directory, as artwork hasn't been added to it.
  • Run render.sh in the command line
  • Add, commit, and push changes
  • Create a new release with the appropriate tag
  • Update the readme Changelog with new release; link to issues tied to the milestone. Example for Release 2.1.0: https://github.com/nationalparkservice/npmap-symbol-library/issues?q=is%3Aclosed+milestone%3A%22Release+2.1.0%22

Deprecated procedure below. Do not update npmap.js; it should stay tied to v2.3.0.

Open an issue on the npmap.js repository to update it with the latest symbol library release.

In the npmap.js repo:

• Update the symbol dependency in package.json with the latest version number.
• Commit with a message along the following lines: "Bump symbol library to version x.x.x, fixes #xxx". #xxx references the issue created above.
• Release a new version of npmap.js
• In npmap-builder, update var npmapjsVersion = 'x.x.x' in app.js