Skip to content
This repository has been archived by the owner on May 19, 2021. It is now read-only.

Latest commit

 

History

History
62 lines (41 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 1.91 KB
Raw

Development

Styling

If you need to change the appearance of the dropdown, you can easily make it so that autocomplete dropdown doesn't close so that you can inspect it.

To do so, simply comment out the three lines here: https://github.com/algolia/github-awesome-autocomplete/blob/master/code/js/libs/typeahead.bundle.js#L1523.L1525

Make sure you re-build after making the change. Also, do not forget to remove the commented lines when committing the changes.

RELEASING

Make sure you are on a clean master branch.

Run & follow the instructions:

scripts/release.sh

This will do several things:

  • Ask for the new version
  • Update the version number throughout the codebase
  • Add the latest changes to the CHANGELOG.md
  • Commit everything to a new chore(release): $PACKAGE_VERSION commit
  • Push the changes to the git repository
  • Tag the release commit with the version number and push the tags to the repository

After this, you still need to manually publish the extensions on the different marketplaces. All archives are ready in the build directory.

Release Chrome extension

By leveraging the Chrome WebStore API endpoints (recommended):

yarn run webstore upload \
    --source "build/unpacked-prod" \
    --extension-id "djkfdjpoelphhdclfjhnffmnlnoknfnd" \
    --client-id "to-be-filled" \
    --client-secret "to-be-filled" \
    --refresh-token "to-be-filled" \
    --auto-publish

Manually:

You need to be invited to the Google Group owning the extension.

You can then send a new version from: https://chrome.google.com/webstore/developer/dashboard/u58fa06d3b25b4f42f07dbb3900b3ceb5

Release Firefox extension

Go here: https://addons.mozilla.org/en-US/developers/addon/github-awesome-autocomplete/versions/submit/agreement

When asked for the archive, send the zip archive named: build/firefox-x.x.x.zip.

Next steps are straight forward.

Release Safari extension

TODO