Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump apidoc from 0.29.0 to 0.50.1 #1118

Merged
merged 1 commit into from
Nov 18, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 1, 2021

Bumps apidoc from 0.29.0 to 0.50.1.

Release notes

Sourced from apidoc's releases.

apidoc-0.50.1

0.50.1

apidoc-0.50.0

This release marks a new era of this project. Many things have been done and a lot of the code has been improved/modified/fixed. One major change is for instance the merge of apidoc-core back in the main apidoc repo.

Normally you will be able to run this new version on your existing codebase with no changes and it should work. But as you can imagine, there are still probably a few bugs here and there, so please make sure to report them through a GitHub issue!

0.50.0

BREAKING CHANGES

  • --silent renamed to --quiet or -q for short
  • --color renamed to --no-color to disable color in log output
  • --parse was deleted because it is the same as --simulate
  • --simulate renamed to --dry-run / -n
  • Default output is not json, use "--log-format json" to get json
  • --config / -c must be a path to a file, not a directory
  • Node v14.x required

FIXED

  • Fix sampleUrl config option behavior:

    • if it is absent or false, no sample block will be generated
    • if it is true, the current page location will be used
    • if it is an url, that will be used Note that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of true for sampleUrl to get the same behavior.
  • Fix non working sortFields function (fix #968)

  • Fix syntax highlighting for markdown parsed text

  • Fix color in logs was not showing since upgrade to winston 3

  • Fix newlines being removed in pre tags (fix #809 by @​JayBerlin)

  • Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @​esaracco)

  • Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @​esaracco)

  • Fix apiSampleRequest not working (fix #984 via #1023 by @​esaracco)

  • Fix error with parenthesis in apiGroup (fix #994 via #1022 by @​esaracco)

  • Fix absent diff on different api route (fix #963 via #1030 by @​esaracco)

ADDED

  • Add request method to compare template (#986 by @​klickagent)
  • Add some shorthand options, see apidoc -h
  • Add --log-format option for json output (default is not json)

... (truncated)

Changelog

Sourced from apidoc's changelog.

0.50.1

0.50.0

BREAKING CHANGES

  • --silent renamed to --quiet or -q for short
  • --color renamed to --no-color to disable color in log output
  • --parse was deleted because it is the same as --simulate
  • --simulate renamed to --dry-run / -n
  • Default output is not json, use "--log-format json" to get json
  • --config / -c must be a path to a file, not a directory

FIXED

  • Fix sampleUrl config option behavior:

    • if it is absent or false, no sample block will be generated
    • if it is true, the current page location will be used
    • if it is an url, that will be used Note that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of true for sampleUrl to get the same behavior.
  • Fix non working sortFields function (fix #968)

  • Fix syntax highlighting for markdown parsed text

  • Fix color in logs was not showing since upgrade to winston 3

  • Fix newlines being removed in pre tags (fix #809 by @​JayBerlin)

  • Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @​esaracco)

  • Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @​esaracco)

  • Fix apiSampleRequest not working (fix #984 via #1023 by @​esaracco)

  • Fix error with parenthesis in apiGroup (fix #994 via #1022 by @​esaracco)

  • Fix absent diff on different api route (fix #963 via #1030 by @​esaracco)

ADDED

  • Add request method to compare template (#986 by @​klickagent)
  • Add some shorthand options, see apidoc -h
  • Add --log-format option for json output (default is not json)
  • Add ascii art in verbose mode
  • Add --warn-error to treat warnings as error (fix #703)

ENHANCEMENTS

  • HUGE CLEANUP OF THE CODEBASE
  • Merge apidoc-core back into the apidoc repository. The apidoc-core repository is now read-only.

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Nov 1, 2021
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/apidoc-0.50.1 branch from 5db1a29 to 401f442 Compare November 4, 2021 05:08
Bumps [apidoc](https://github.com/apidoc/apidoc) from 0.29.0 to 0.50.1.
- [Release notes](https://github.com/apidoc/apidoc/releases)
- [Changelog](https://github.com/apidoc/apidoc/blob/master/CHANGELOG.md)
- [Commits](apidoc/apidoc@0.29.0...0.50.1)

---
updated-dependencies:
- dependency-name: apidoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/apidoc-0.50.1 branch from 401f442 to 86ca1a5 Compare November 18, 2021 02:13
@coveralls
Copy link

Pull Request Test Coverage Report for Build 3778

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.03%) to 61.804%

Totals Coverage Status
Change from base Build 3776: 0.03%
Covered Lines: 7058
Relevant Lines: 10893

💛 - Coveralls

@gcampax gcampax merged commit b0402dd into master Nov 18, 2021
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/apidoc-0.50.1 branch November 18, 2021 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants