1.0.7 • Published 1 year ago

@dev-intellimind/create-pr v1.0.7

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

create-pr

Quickly create a CodeCommit PR and its corresponding Notion entry.

Setup

To install this package, run ↴

$ pnpm i -g @dev-intellimind/create-pr

This will install the package globally, meaning the command can be invoked anywhere.

To successfully run the command, it's necessary that the working directory contains a .internal.json file with atleast the following contents ↴

{
    "create-pr": {
        "awsRegion": "...",          // Ex. eu-west-1
        "repository": "...",         // Ex. CVO-Infinity
        "defaultDestination": "...", // Ex. dev
        "notionPrDatabase": "...",   // Ex. Pull Request - FE
        "notionTaskDatabase": "..."  // Ex. Dev Tasks
    }
}

Development

After making changes to index.ts, you must compile it before you can test/publish by running ↴

$ pnpm build

To test the package, you can run pnpm start.
If you want to test the package from other directories, you'll need to create a global link first ↴

$ pnpm ln -g   # from the package directory

Note that after creating the global link, you can only remove it by removing the package ↴

$ pnpm rm -g @dev-intellimind/create-pr

Don't forget to reinstall the package if you still plan to use the published version.

When you're ready to publish a new version of the package, update the version in package.json and run ↴

$ pnpm publish --access public

To authenticate the command above, you have 2 options:

  • Run npm login beforehand (which requires our NPM account credentials).
  • Generate an access token from our NPM account page and add it to your systems environment variables under the name NPM_TOKEN. All NPM commands in this package directory will then be authenticated thanks to the .npmrc file.