Skip to content

Commit

Permalink
chore: publishing scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
kokovtsev committed May 3, 2023
1 parent 9863318 commit 4911d6c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
17 changes: 14 additions & 3 deletions docs/development/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down

0 comments on commit 4911d6c

Please sign in to comment.