Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 3.2 KB

README.md

File metadata and controls

58 lines (38 loc) · 3.2 KB
Raw

Open Access Button Unified Extension

===============

This is the Button's WebExtension which runs on Firefox and Chrome (and maybe Opera) which encapsulates functionality of the incumbent Open Access Button and Open Data Button.

Contributing

Our main repository contains far more information on the project, how to contribute etc.

Quick guide:

  • If you have an issue (e.g bug, suggestion, question), make it here
  • If you want to contribute code to the plugin do it in this repository. Pull requests are always welcome. Some useful information is below.

# Development notes

Branches, master vs develop.

  • master is our stable, released code.
  • develop is what we're currently working on now.

packaging for Firefox

Firefox requires extra keys in the manifest, and the project files zip archived with extension .xpi. The script pack.py does this.

Install from development

Getting the latest extension

  • Go to code page for this repo page, plugin.
  • Be sure you are on the develop branch, if not, switch to develop in the drop down option on the top left of the page.
  • click the big green button on the top right that says 'clone or download'.
  • click download to get a zip file of the latest extension.
  • Download the zip.
  • Navigate and find the file on your computer, double click it to unzip it. You now have the latest code.

However, we commonly use releases on this repository. It may be better to use a recent release, which can be found here Pre-releases are on dev, other releases are on live.

Or, for leet coders

  • git clone
  • git checkout develop

Installing the file on Chrome

  • In Chrome, go to chrome://extensions via the url bar, tick the 'Developer mode' tick-box in the top right corner.
  • Click the newly appeared 'Load unpacked extension...' button
  • Browse to the project directory you just downloaded, click 'Select'. It will upload the zip file you just downloaded.
  • If you're experiencing problems with any of these steps, feel free to leave an issue on the discussion repository here.

Managing releases

  • Only releases tagged "Release" can be put in the Chrome Store. Anything tagged "pre-release" will only work in development. Any time we want to release something new out to chrome, it will always be the latest live release that can be pushed to the chrome store.
  • Releases can be made through the Chrome store here: https://chrome.google.com/webstore/category/extensions while logged into the leads Open Access Button Account.
  • Releases should be tested on master, just in case, after release.
  • Releases tagged pre-release will increment whenever we push new features/fixes etc, and the most recent pre-release should be used for testing, then once testing is confirmed, we will make a live release.
  • Firefox packages are similar - ones in pre-release on dev will connect to the dev API. Live releases, on master, will connect to the live API