Skip to content

Commit a8f5ed4

Browse files
authored
chore(release): publish to npm with CHANGELOG
* fix(save): ensure module's save method functions Added a #save method to baseResourceConveter, which invokes fileExporter.save. 😒 GH-16 * docs(readme): update API section Enumerate all sections. GH-16 * style(manifest): format GH-16 * docs(readme): fix typo Replace octokit ➡️ grc GH-16,GH-17 * fix(save): add save method to module GH-18 * build(changelog): add standard-version Use standard-version to generate a CHANGELOG, since semantic-release does not appear to have this feature. GH-18 * docs(changelog): add v1.0.0 to log GH-18
1 parent 89981dd commit a8f5ed4

4 files changed

Lines changed: 39 additions & 15 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -752,6 +752,7 @@
752752
| [nsp@^3.2.1](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.2.1 | Apache-2.0 | dev |
753753
| [prettier@1.11.1](https://prettier.io) | Prettier is an opinionated code formatter | 1.11.1 | MIT | dev |
754754
| [semantic-release@15.1.5](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 15.1.5 | MIT | dev |
755+
| [standard-version@4.3.0](https://github.com/conventional-changelog/standard-version#readme) | replacement for `npm version` with automatic CHANGELOG generation | 4.3.0 | ISC | dev |
755756
<!-- AUTO-GENERATED-CONTENT:END -->
756757
757758
## 8. **APIs**

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4+
5+
<a name="1.0.1"></a>
6+
7+
## [1.0.1](https://github.com/gregswindle/github-resource-converter/compare/v1.0.0...v1.0.1) (2018-04-04)
8+
9+
### Bug Fixes
10+
11+
* **save:** add save method to module ([7704a9f](https://github.com/gregswindle/github-resource-converter/commit/7704a9f)), closes [#18](https://github.com/gregswindle/github-resource-converter/issues/18)
12+
* **save:** ensure module's save method functions ([1f7a111](https://github.com/gregswindle/github-resource-converter/commit/1f7a111)), closes [#16](https://github.com/gregswindle/github-resource-converter/issues/16)
13+
* **save:** implement "save" method for Node.js API ([#17](https://github.com/gregswindle/github-resource-converter/issues/17)) ([7e22c30](https://github.com/gregswindle/github-resource-converter/commit/7e22c30))
14+
15+
<a name="1.0.0"></a>
16+
17+
## 1.0.0 (2018-04-03)
18+
19+
### Bug Fixes
20+
21+
* **cli:** import fs-extra ([#11](https://github.com/gregswindle/github-resource-converter/issues/11)) ([3b988cf](https://github.com/gregswindle/github-resource-converter/commit/3b988cf)), closes [#1](https://github.com/gregswindle/github-resource-converter/issues/1) [#4](https://github.com/gregswindle/github-resource-converter/issues/4) [/travis-ci.org/gregswindle/github-resource-converter/jobs/355791728#L2892](https://github.com//travis-ci.org/gregswindle/github-resource-converter/jobs/355791728/issues/L2892) [#1](https://github.com/gregswindle/github-resource-converter/issues/1) [#2](https://github.com/gregswindle/github-resource-converter/issues/2) [#3](https://github.com/gregswindle/github-resource-converter/issues/3) [#4](https://github.com/gregswindle/github-resource-converter/issues/4) [#10](https://github.com/gregswindle/github-resource-converter/issues/10)
22+
23+
### Features
24+
25+
* **deployment:** enable semantic-release ([#13](https://github.com/gregswindle/github-resource-converter/issues/13)) ([6b85819](https://github.com/gregswindle/github-resource-converter/commit/6b85819)), closes [#12](https://github.com/gregswindle/github-resource-converter/issues/12)

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "github-resource-converter",
33
"description":
44
"Convert and export GitHub resources--Issues and Pull Requests--to CSV and JSON.",
5-
"version": "1.0.0",
5+
"version": "1.0.1",
66
"author": {
77
"name": "Greg Swindle",
88
"email": "greg@swindle.net",
@@ -78,7 +78,8 @@
7878
"markdown-magic-package-scripts": "1.2.1",
7979
"nsp": "^3.2.1",
8080
"prettier": "1.11.1",
81-
"semantic-release": "15.1.5"
81+
"semantic-release": "15.1.5",
82+
"standard-version": "4.3.0"
8283
},
8384
"engines": {
8485
"node": ">=8.0.0"
@@ -139,30 +140,21 @@
139140
"lint-staged": {
140141
"*.js": ["npm run lint:js", "git add"],
141142
"*.json": ["npm run lint:json", "git add"],
142-
"*.md": ["npm run lint:md", "npm run docs", "git add"]
143+
"*.md": ["npm run lint:md", "npm run docs", "git add"],
144+
"*": ["npm run docs:changelog", "git add"]
143145
},
144146
"main": "lib/index.js",
145147
"prettier": {
146148
"semi": false,
147149
"singleQuote": true
148150
},
149-
"release": {
150-
"generateNotes": {
151-
"preset": "angular"
152-
},
153-
"prepare": [
154-
"@semantic-release/changelog",
155-
"@semantic-release/npm",
156-
"@semantic-release/git"
157-
],
158-
"verifyConditions": ["@semantic-release/npm", "@semantic-release/git"]
159-
},
160151
"repository": {
161152
"type": "git",
162153
"url": "https://github.com/gregswindle/github-resource-converter.git"
163154
},
164155
"scripts": {
165156
"docs": "npm run docs:toc",
157+
"docs:changelog": "standard-version -a",
166158
"docs:toc":
167159
"md-magic --config '.github/config/markdown.config.js' --path '**/*.md' --ignore 'node_modules'",
168160
"lint":
@@ -187,5 +179,11 @@
187179
"test:config": "jest --showConfig",
188180
"test:watch": "jest ./lib/__tests__/*.test.js --watch",
189181
"test:watch:all": "jest ./lib/__tests__/*.test.js --watchAll"
182+
},
183+
"standard-version": {
184+
"skip": {
185+
"commit": true,
186+
"tag": true
187+
}
190188
}
191189
}

0 commit comments

Comments
 (0)