UNPKG

changesets-github-release

Version:
36 lines 2.07 kB
{ "name": "changesets-github-release", "version": "0.1.0", "description": "", "keywords": [ "changesets" ], "homepage": "https://github.com/PabloSzx/changesets-github-release#readme", "bugs": { "url": "https://github.com/PabloSzx/changesets-github-release/issues" }, "repository": { "type": "git", "url": "git+https://github.com/PabloSzx/changesets-github-release.git" }, "license": "MIT", "author": "PabloSzx <pablosaez1995@gmail.com>", "main": "dist/index.js", "bin": { "gh-release": "dist/index.js" }, "files": [ "dist" ], "devDependencies": { "@babel/runtime": "^7.16.7", "@types/node": "^17.0.13", "commander": "^9.0.0", "dotenv": "^15.0.0", "github-release-cli": "^2.1.0", "tsup": "^5.11.13", "typescript": "^4.5.5" }, "scripts": {}, "readme": "# changesets-github-release\n\nAutomatize publishing GitHub releases after every [changesets](https://github.com/atlassian/changesets) publish\n\n## Installation\n\n```bash\npnpm add -D changesets-github-release\n```\n\nor\n\n```bash\nyarn add -D changesets-github-release\n```\n\nor\n\n```bash\nnpm install -D changesets-github-release\n```\n\n## Usage\n\nFirst it assumes the presence of the `GITHUB_TOKEN` environment variable (you also can create a local .env in the same folder of the package including it).\n\nIn your `package.json` add a `postpublish` scripts as it follows:\n\n```json\n{\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/repo-owner/repo-name\"\n },\n \"scripts\": {\n \"postpublish\": \"gh-release\"\n }\n}\n```\n\nYou also can specify the target GitHub repository using the \"--repo\" argument:\n\n```json\n{\n \"scripts\": {\n \"postpublish\": \"gh-release --repo repo-owner/repo-name\"\n }\n}\n```\n\nYou also can specify the target GitHub repository using the `GITHUB_REPO` environment variable\n\n> .env\n```env\nGITHUB_TOKEN=XXXXXX\nGITHUB_REPO=repo-owner/repo-name\n```\n\n```json\n{\n \"scripts\": {\n \"postpublish\": \"gh-release\"\n }\n}\n```\n" }