Update for Chromatic Publish Action

[jamigibbs]

Chromatic

https://chromatic-publish-error--60f9b557105290003b387cd5.chromatic.com

Description

Our Chromatic github workflow for publishing Storybook previews stopped working a few days ago. There is an issue reported to the chromatic-cli that is similar to what we are experiencing:

The resolution mentioned in that issue is to add an empty "scripts": {}, tag to the root package.json file but this did not work in our case (see the failure below in commit ffb57dc).

Adding a "fake script" does work though (which is how this PR is passing at the moment):

  "scripts": {
    "chromatic-bridge": "echo \"Nothing to see here\""
  },

In an older issue, the following was suggested to avoid having to add an unnecessary script tag to the root package.json:

Can you try adding the --storybook-build-dir REPLACE_ME_WITH_DIR here? The CLI currently infers how to build your storybook from the package.json file. If you build your storybook using the NX command and then point the CLI at the output directory using the flag above, you should get the desired outcome. Docs: https://www.chromatic.com/docs/cli#storybook-options

But it seems like we already have the --storybook-build-dir option set in our Github workflow so I'm not sure if it needs to be added somewhere else too?

https://github.com/department-of-veterans-affairs/component-library/blob/main/.github/workflows/chromatic.yml#L40

        uses: chromaui/action@v1
        with:
          token: $
          # 👇 Chromatic projectToken, refer to the manage page to obtain it.
          projectToken: $
         storybookBuildDir: packages/storybook/storybook-static

Testing done

Screenshots

Acceptance criteria

• [ ]

Definition of done

• Documentation has been updated, if applicable
• A link has been provided to the originating GitHub issue (or connected to it via ZenHub)

[Andrew565]

Agreed that this feels hacky, but at least it works and doesn't introduce any weird side effects.