search

bootprint / bootprint-openapi

Bootprint-module to render OpenAPI specifications, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-openapi
MIT License
357 stars 48 forks source link

Version info #62

Closed mada4586 closed 8 years ago

mada4586 commented 8 years ago

The generated HTML omits the obligatory "version" property of the "info" object - quite an important one. This PR fixes that by putting the API version immediately below the title.

A default styling is also included.

nknapp commented 8 years ago

Thanks for the PR. I really appreciate the help. It would be great if you could add a test case similar to the one for global params. Just copy the test into a new folder and modify the included spec and the assertions. I really think it would be good to have this test-coverage to prevent errors in the future.

In the end, the PR should be merged into a single commit with an appropriate commit-message. You can use thoughtful-release to do that. This is important, because the first line of the command will be part of the changelog.

nknapp commented 8 years ago

I've invited you to the Bootprint organization. Accept if you like. You could then merge the PR itself. I would just ask you to keep to the rules (write tests for new features, one commit per feature) and never commit to the master directly, but create pull-requests for discussion.

nknapp commented 8 years ago

Hi, sorry about the delay. I didn't get a notification of the update. The PR looks great. You could include your name in the copyright-notice of the test and not mine, if you want. Feel free to do a squash and merge. If you don't have the appropriate access-rights, let me know.

I'll publish to npm then

mada4586 commented 8 years ago

Hi, I think I've merged the changes correctly. I didn't use thoughtful-release only the built-in squash-and-merge function. I'm not sure: at what point should the changelog be edited? Just before producing a version, I guess, so that its number is known.

nknapp commented 8 years ago

I'll have a look at it tonight. Thank you.

nknapp commented 8 years ago

When I made my first comment, GitHub did not have this functionality yet (at least I didn't know of it), but now I would also prefer GitHub's squash-and-merge to thoughtful-release.

For the release, I always use the release-tools-module. It calls npm version to bump the version and with npm>2.14 this will call the version-script in the package.json. The version-script call thought to update the documentation and thoughtful-release to generate a changelog from the git history.

I should probably document it somewhere...

Well, the package is published. I will update https://bootprint.knappi.org on Wednesday (probably).