ServiceNow Code Review

Installation

npm install -g servicenow-codereview

Usage

1. Create a scratch branch
2. Commit to a scratch branch
3. Use cr create command to create a code review
4. Do the review process in GitLab
5. When ready, merge your scratch branch into your track branch with cr merge

Example

# from a base track branch
$ git checkout track/sp

# create a scratch branch and commit
$ git checkout -b scratch/ui/PRB123456
$ git commit ...
$ git commit ...

# create a code review on gitlab and push your changes
$ cr create --base track/sp --desc "My code review for PRB123456"

# iterate on your code and push changes to gitlab / code review
$ git commit ...
$ git commit ...
$ cr push

# rebase track branch and then force push
$ git rebase track/sp
$ cr push --force

# merge your changes into track branch
$ git checkout track/sp
$ cr merge scratch/ui/PRB123456

# push your merged code to the track
$ git push

Development

Clone the repository from GitLab and install dependencies with npm

git clone [email protected]:service-portal/sncodereview.git
cd sncodereview
npm install

To install and use the CLI tool in source control, run: npm install -g && npm link

Testing

There are currently no unit tests, but you can run the linter to detect code issues:

npm run lint

Publishing

npm publish

That's it, but you have to ask Patrick to add you as a collaborator on npmjs.com.

Caveats

• This requires a relatively new version of node