Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #13

Merged
merged 4 commits into from Jan 24, 2019
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file
Failed to load files.

Always

Just for now

@@ -6,16 +6,23 @@ Builds HTTPS Everywhere ruleset files for Brave.

If there are rulesets that are broken and need to be disabled, add them to the `exclusions` list.

If there is a breaking ruleset format change, bump the version number in
`package.json` by one major point release. (Ex: 5.2.21 to 5.3.0. The minor
point number is no longer used and can be set to anything.)
## Building locally

## Building
npm install
npm run build

`npm run build`
## Testing locally

## Uploading to S3
1. Copy `out/httpse.leveldb.zip` into `~/BraveSoftware/Brave-Browser-Beta/oofiananboodjbbmdelgdommihjbkfag/*/*/` overwriting the existing file.
2. Delete the `httpse.leveldb` directory.
3. Unzip `httpse.leveldb.zip`.
4. Start the browser and ensure that <https://https-everywhere.badssl.com/> works.
5. Find a site that was added in the last release and check that it gets upgraded. Check it first with `curl --head` to make sure it doesn't redirect to HTTPS server-side.

`npm run upload [-- --prod]`
## Releasing a new version

Without the `prod` option, this uploads to the test bucket.
1. Connect to the Brave VPN.
2. On Jenkins, look for the `brave-core-ext-https-everywhere-update-publish` job.
3. Click "Build Now".

Once that's done, the new extension should be available within a few minutes.
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.