This repository was archived by the owner on May 4, 2023. It is now read-only.

58 lines (40 loc) · 1.44 KB

Development

Getting Started

Install the dependencies
```
npm i
```

Create a symlink

npm link

# if you have the NPM package installed
# you'll need to force this link
npm link --force

You're all set now, open help to see a list of commands
```
codiga --help
```

Running the tests

Install and symlink the package as described in the Getting Started
```
npm i
npm link
```
Run the test script
```
npm run test
```

We'll automatically run the tests on push and merge-request actions. You can see past workflow runs here.

Release a new version

Open a MR with your new changes
- Bump the version in package.json and package-lock.json and commit it as well
Once that's merged, go to releases and draft a new release
- Choose a tag > Create a new tag > vX.X.X (should match your new version above)
- Generate release notes
- Publish release
Verify the following:
- The Release Github Action is successful
- The NPM package was updated

Notes

If you're using nvm to change between node versions, you'll need to repeat the above for each version as the symlink step only links with the current node version.