diff --git a/docs/development/overview.md b/docs/development/overview.md index 1473736..a9016a3 100644 --- a/docs/development/overview.md +++ b/docs/development/overview.md @@ -4,8 +4,19 @@ TODO: describe the architecture and data flows ### FAQ 1. **Why don't spec codecs reuse common parts?** - - That's because different versions of specs refer to different versions of [JSON Schema](http://json-schema.org) and they are generally not the same. We would like to avoid maintaining JSON Schema composition in this project. (for now) + + That's because different versions of specs refer to different versions of [JSON Schema](http://json-schema.org) and they are generally not the same. We would like to avoid maintaining JSON Schema composition in this project. (for now) ### Publish -`npm version major|minor|patch` + +GitHub Actions are configured to build and publish a new version when a [new release](https://github.com/devexperts/swagger-codegen-ts/releases/new) is created in GitHub. + +If you need to run this process manually: +``` +# bumps the version in package.json, builds the dist files +# and commits the updated CHANGELOG.md +yarn version + +# uploads the package to the registry +yarn publish +``` diff --git a/package.json b/package.json index 5906f2c..0d21734 100644 --- a/package.json +++ b/package.json @@ -11,10 +11,10 @@ "test": "yarn test:lint && yarn test:jest && yarn test:build", "prettier": "prettier --list-different \"./src/**/*.ts\" \"./test/**/*.ts\"", "prettier:fix": "prettier --write \"./src/**/*.ts\" \"./test/**/*.ts\"", - "prepublishOnly": "yarn test && yarn build", "start": "nodemon --exec \"yarn test:run\"", "build": "tsc -p tsconfig.build.json", - "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0", + "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s", + "preversion": "yarn test && yarn build", "version": "yarn changelog && git add CHANGELOG.md" }, "bin": {