Release process

To publish the package

1. Bump the version number in package.json and src/linter.ts.

2. Run node ./scripts/generate-changelog.js (after building it with tsc -p scripts) to generate the changelog diff. This script expects a Github.com personal access token to exist at ~/github_token.txt with "repo" permissions. Copy the information that the script generates to the CHANGELOG.md file and clean it up / do some copy editing.

3. Commit with message Prepare release <version>.

4. Push your branch (for example, named `ad/prep-5.15.0') to GitHub and make a PR.

5. Once your PR is merged, wait for the tests to pass on CircleCI for master.

6. Create a "Release" on GitHub with the proper tag version and notes from CHANGELOG.md. The tag should be identical to the version in package.json.

7. Run yarn run publish:local. The New version prompted by the publish script should be the same release version you have been using everywhere else.

To build the docs

1. Pull master locally (your directory should be called tslint)

2. As a sibling to tslint, clone it again (call it tslint-gh-pages) and check out the gh-pages branch.

   Shortcut: git worktree add -b gh-pages ../tslint-gh-pages origin/gh-pages

3. Run yarn compile && yarn docs in the tslint directory.

4. Checkout a new branch (in the tslint-gh-pages directory) based on gh-pages.

5. Copy tslint/docs/* to tslint-gh-pages

6. Commit your changes to tslint-gh-pages and create a PR.

7. Once the PR is merged, the docs should be released automatically.