Web Package Template

• Setup
• How to Publish

Setup

Step 1: Create a new repo using this template

Option 1: via new repo page

Option 2: via this repo

Step 2: Clone your new repo

$ git clone [email protected]:traveloka/<repo_name>.git
& cd <repo_name>

Step 3: Setup your new repo

$ yarn setup

Step 4: Register this repo to Circle CI

1. Go to https://circleci.com/add-projects/gh/traveloka (authorize github if needed)

2. Search your new repo & click "Setup Project" (may take a while)

3. Trigger your first build!

That's it! Have fun 😉

How to Publish

Step 1: Register NPM publish token

Note: you only need to do this once.

In order for us to automate the publishing process, you will need to register the NPM publish token to the repo. Since access to this token is limited to certain group of people only, please ask @web-infra team on Slack to register it for you using the following template:

Hi @web-infra, please help register NPM publish token to our repo (https://github.com/traveloka/<your-repo-name>) for automatic publishing.

Repo purpose: (provide some details about the repo).

How to register NPM publish token (for @web-infra): Key: NPM_AUTH_TOKEN

Step 2: Cut a tag

$ yarn release
$ git push --follow-tags

Under the hood, the yarn release command uses standard-version utility to do the following tasks (simplified):

• NPM package version bump
• Changelog generation (if your commit message follows the Conventional Commits standard)
• Git tagging

Finally, the second command will push your newly created tag to your remote & trigger the automated publishing process. To see the progress, just click on the "Actions" tab on your Github repo page.