README.md

The master list for our product images.

To add new images - general

Put the image in the correct folder

SKU-specific images go in photos/[product category]/[product name]/[SKU]/[photo-here-name-doesn't-matter].jpg

General product images, as well as potential editorial and header images, go in photos/[product category]/[product name]/product/[photo-here-name-doesn't-matter].jpg.

Run the renamer script

Photos will be automatically renamed with a meaningful name (based on SKU or product name) and given a number to differentiate between them. Note that any prefixed '!' character survives the rename, and bang (publishable)/non-bang(non-publishable) photos are numbered separately.

Selecting which images to publish

SKU-specific images and general product photos: any filename prefixed with a bang ('!') will be copied to the _live folder (with the appropriate filename) when the publish script is run.

Editorial and header images will only be copied from the _editorials and _headers subfolders (since these will require manual action to create). In these folders the ! is unnecessary, but any file prefixed with ! will expect a square editorial image rather than the usual dimensions (based on the golden ratio).

For each SKU, the SKU photo number 1 will be set to the appropriate product variant's image_id (i.e. the variant image will be set to image numbered 1).

Uploading Manually

You can drag photos from the _live folder after running the prepare, or better yet just run the publish script (bin/publish) to sync automatically. Note: when uploading manually, wait for each folder to complete uploading before dragging another (otherwise Shopify gets confused).

Uploading Automatically

The publish script (bin/publish) is run as the git pre-commit hook... if you want to check in files that aren't yet valid (ideally only while setting up the initial mirroring), commit with git commit --no-verify.

One-off Manipulation

There's an App.call_with_block method that allows you to run arbitrary ruby code for each ProductDirectory. Use in a script like, for example:

    #!/usr/bin/env ruby
    require_relative '../lib/app'

    dir = App.photos_dir

    # Example: copying editorial photo to product dir if accidentally was moved over rather than copied
    App.call_with_block(dir) do
      next unless path =~ /xmas/
      next unless entries('_editorials').length == 1
      editorial = Traversal::File.new(path+'/_editorials/'+entries('_editorials')[0], 1)
      editorial_md5 = editorial.file_hash


      if matched = select_live_photos.select {|k,d| !k.match(/editorial/) }.detect {|key, data| data['source_md5'] == editorial_md5 }
        puts "\t[#{product_dir_name.cyan}] editorial has hash #{editorial_md5}, which matches photo #{matched[0]}".light_black
      else
        puts "\t[#{product_dir_name.cyan}] Would copy #{editorial.live_name} to products dir"
        FileUtils.cp editorial.full_path, path+'/product/!temp_from_editorial.jpg'
      end
    end

EXIF + Alt Tags

By default all metatag data is stripped from the photos in the optimization phase, but EXIF_METADATA_TO_KEEP (in photos/base`) stores a list of EXIF tags to persist to the live version.

By default this includes imagedescription; if a value is present for this key, we use that to set the ALT tag when uploading product images to Shopify.

For editing the EXIF metadata, we recommend https://github.com/hvdwolf/pyExifToolGUI/releases (clunky but functional) or, on Windows, https://github.com/jim-easterbrook/Photini (untried).

Force processing

Note that changed EXIF tags aren't detected as file content changes. To force reprocessing all images (e.g. if you've just changed a bunch of EXIF data), run with FORCE_PROCESS_ALL=1.

Similarly, to force uploading even if the metadata hashes imply upload isn't needed, run with FORCE_SYNC_ALL_IMAGES=1.

Finally, to effectively remove all local _live images and reprocess all: REPROCESS_ALL_FILES=1.

Only process specific product

e.g. ONLY_TRAVERSE_PRODUCT="sunglasses/robinson - 9315805897" bin/publish will only publish the specified product.

Overwriting the original photos

By default all resizing, optimizing, etc. is done to a copy of the photo but the originals aren't changed (to enable storing e.g. higher resolution originals). If you run with OVERWRITE_ORIGINALS=I_ACCEPT_THE_DANGER, the originals will be overwritten with the post-processed versions (to enable e.g. no need to reduplicate all optimization steps on each deploy).

Site not updating

Note that setting the variant-image to the #1 image for the associated SKU doesn't appear to be syncing correctly. When in doubt, use bamboo-habitat's bin/oneoffs/set-variant-images.rb.