Easily add content to your Screenly digital signage displays in a few clicks. ✨

🌱 Install

• Install the extension from the Chrome Web Store.
• Install the extension from Firefox Add Ons.

💻 Develop

The extension is built using webpack.

$ PLATFORM=<PLATFORM> \
  VERSION=<VERSION> \
    ./bin/start_development_mode.sh

Important

• VERSION can be any valid version semver string (X.Y.Z), where X, Y, and Z are non-negative numbers.
• PLATFORM can be either chrome or firefox.

Now load the content of the dist/ folder as an unpacked extension in Chrome. As you make changes to the code, the extension is automatically rebuilt.

Distribute

$ VERSION=<VERSION> \
  PLATFORM=<PLATFORM> \
    ./bin/package_extension.sh

🧪 Run Unit Tests

$ ./bin/run_tests.sh

Chrome

• Build the extension in dev mode.
• Load the extension as an unpacked extension from the dist folder.
• Find the extension URL and then open chrome-extension://<extension-id>/test/tests.html in Chrome.

Firefox

• Build the extension in dev mode.
• Open Firefox and navigate to about:debugging.
• Click on This Firefox and then Load Temporary Add-on.
  • You can either select the manifest.json file or the zipped extension.
• Find the extension URL and then open moz-extension://<extension-id>/test/tests.html in Firefox.

🚀 Release

• Generate a new release tag in git:

$ git pull
$ git checkout master
$ git tag
[...]
$ git tag -a vX.Y.Z -m "tl;dr changelog."
$ git push origin vX.Y.Z

• Navigate to the GitHub releases and click 'Draft a new release'.
• Select the tag you just created above and provide a release title and description.
  • You can use git diff v0.2.0..v0.3.0 to diff between the current and previous release to help you with the changelog.
• Go to the CI Job and pull down the release .zip files for the release you created.
  • You can verify the .zip files you downloaded with the GitHub CLI by running gh attestation verify path/to/release.zip --owner Screenly.

Chrome

• Navigate to Chrome Web Store Developer Dashboard.
• Select the right publisher account and upload screenly-chrome-extension.zip you downloaded before.

Firefox

• Navigate to Firefox's Add-on Developer Hub.
• Uploadscreenly-firefox-extension.zip you downloaded before.