feat: improved documentation site and release process #40
Conversation
|
@maoo can you provide a bit more context as to the reason for/changes in this PR? Do you have an example of how the output will look? It is a bit hard to review without that. |
package.json
Outdated
| @@ -1,17 +1,40 @@ | |||
| { | |||
| "name": "fdc3-api", | |||
| "version": "1.0.0", | |||
| "name": "@finos/fdc3-api", | |||
There was a problem hiding this comment.
I know you'd like to have this under @finos, however, this project provides TypeScript definitions which are conventionally released under the @types scope. The TypeScript compiler has special behaviours that rely on this convention, so we should try to keep to it.
There was a problem hiding this comment.
There was a problem hiding this comment.
Good point. Ok, I'll use the @types scope. We can still add finos npmjs user as collaborator, which will show up the package in the FINOS Org homepage.
|
|
||
| On every commit, [semantic release](https://semantic-release.gitbook.io/semantic-release/) will be executed by Travis CI and - based on the commit message - will decide to trigger a release or not. | ||
|
|
||
| Release managers can use [commitizen](http://commitizen.github.io/cz-cli/) to simplify their commit process; simply install `npm install -g commitizen` and use `git cz` (instead of `git commit`) to commit your changes. |
There was a problem hiding this comment.
It's probably worth noting that if you 'squash and merge' pull requests you have the opportunity to fix commit messages that do not follow the convention.
There was a problem hiding this comment.
I'll add some more text.
@rikoe, sure! http://fdc3-api.finos.org I also notice a conflict with |
|
@maoo Looks great. What does the version number on the site signify? (1.1.5). Arguably the current version of the API spec is 1.0.0-beta or 1.0.0-rc (in semver terms), as it is currently in the review period before 1.0.0 ratification. |
|
Thanks @rikoe , glad to hear you like it. The tagging is the latest tag being released and refers to my personal fork, see https://github.com/maoo/API/releases ; you will also notice that More docs on the release process can be found on https://github.com/maoo/API/blob/master/README.md ; please let me know if there's anything missing there. The way Travis CI is currently configured is that the website gets updated only when a release occurs; this means that, after merging this PR, there should be few manual configuration steps (documented on ODP-52) and a pre-release (ie 0.9.9) to publish the documentation. Hope this clarifies a bit more. |
Read more on https://finosfoundation.atlassian.net/browse/ODP-52
Preview website on http://fdc3-api.finos.org