autorel 0.0.19 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -51
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -200,59 +200,14 @@ run: echo 'Hello, World!'
200
200
 
201
201
  # Types
202
202
 
203
- ## CommitType
204
-
205
- ```typescript
206
- type CommitType = {
207
- type: string;
208
- title: string;
209
- release: 'major' | 'minor' | 'patch' | 'none';
210
- };
211
- ```
212
-
213
- ## ReleaseBranch
214
-
215
- ```typescript
216
- type ReleaseBranch = {
217
- name: string;
218
- channel?: string;
219
- };
220
- ```
221
-
222
- ## Config
223
-
224
- ```typescript
225
- type Config = {
226
- run?: string;
227
- publish?: boolean;
228
- dryRun?: boolean;
229
- noRelease?: boolean;
230
- tag?: string;
231
- pre?: string;
232
- breakingChangeTitle?: string;
233
- commitTypes?: CommitType[];
234
- branches?: ReleaseBranch[];
235
- };
236
- ```
237
-
238
- ## Contribution
203
+ You can find the types defined at [src/index.ts](src/index.ts).
239
204
 
240
- Please contribute to this project! Issue a PR against `main` and request review.
205
+ # Support, Feedback, and Contributions
241
206
 
242
- - Please test your work thoroughly.
243
- - Make sure all tests pass with appropriate coverage.
244
-
245
- ### How to build locally
246
-
247
- ```bash
248
- npm i
249
- ```
250
-
251
- ### Running tests
252
-
253
- ```shell script
254
- npm test
255
- ```
207
+ - Star this repo if you like it!
208
+ - Submit an [issue](https://github.com/mhweiner/jsout/issues) with your problem, feature request or bug report
209
+ - Issue a PR against `main` and request review. Make sure all tests pass and coverage is good.
210
+ - Write about `autorel` in your blog, tweet about it, or share it with your friends!
256
211
 
257
212
  ## Sponors
258
213
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "autorel",
3
- "version": "0.0.19",
3
+ "version": "0.0.20",
4
4
  "description": "Automate semantic releases based on conventional commits. Similar to semantic-release but much simpler.",
5
5
  "license": "MIT",
6
6
  "author": "Marc H. Weiner <mhweiner234@gmail.com> (https://mhweiner.com)",