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

[7.x] Generate core API docs from TSDoc comments (#32148) #34421

Merged
merged 8 commits into from
Apr 4, 2019

Commits on Apr 3, 2019

  1. Generate core API docs from TSDoc comments (elastic#32148)

    * Generate core API docs from TSDoc comments
    
    Uses api-extractor and api-documenter to generate documentation for
    the Kibana core API from TSDoc comments in the source code.
    
    Documentation can be generated using `npm run docs:api`.
    
    I used --no-verify to ignore the following pre-commit hook errors:
    1. Filenames MUST use snake_case - api-extractor.json
       It's possible to specify a different config file, but I prefer to keep the "standard" config file name.
    2. UNHANDLED ERROR: Unable to find tsconfig.json file selecting "common/core_api_review/kibana.api.ts". Ensure one exists and it is listed in "src/dev/typescript/projects.ts"
       This is not a source file, so safe to ignore.
    
    * Flesh out API docs a little bit
    
    * Ignore snake_case check for api-extractor.json
    
    * Ignore api-extractor's review file from pre-commit check
    
    * Try to fix build failing by using masters yarn.lock
    
    * I'm being stupid
    
    * Found a better home for ignoring common/core_api_review/kibana.api.ts
    
    * Node script for detecting core API changes
    
    I initially wanted to include this as a precommit hook, but it takes
    quite long to execute (~12s) so might be better suited as a test or
    as part of the release process.
    
    The script currently fails because api-extractor uses an older version
    of typescript.
    
    * Fix tslint precommit hook ignore condition
    
    * Write tsdoc-metadata.json into ./build
    
    * Add LogMeta and ElasticSearch to exported types & docs
    
    * Suppress logging when running api-extractor from script
    
    * Improve check_core_api_changes script and run as test
    
    * Inline api-extractor.json config
    
    * Fix check_core_api_changes --help flag
    
    * LogMeta TSDoc comments
    
    * check_core_api_changes: fail if api-extractor produces warnings or errors
    
    And print more useful messages to the console
    
    * Move ignored ts files list into dev/file
    
    * Add back build:types since api-exporter cannot operate on source files
    
    * Upgrade api-exporter/documenter
    
    * api-extractor: independantly analyze core/public and core/server
    
    Becasue of microsoft/rushstack#1029
    api-extractor can't use core/index.ts as a single entry point for
    analyzing the public and server API's as isolated namespaces.
    
    Instead we analyze these projects separately. This introduces other
    problems like the api review files and documentation always being
    called "kibana." from the package.json filename.
    
    * Build types as part of build task
    
    * Include types in typescript browser compilation
    
    * Force inclusion of core/public for building types
    
    * Fix api review filename in api-exporter errors
    
    * Update docs and API review files
    
    * Fix api-extractor warnings
    
    * Remove ts file ignored list since it's no longer necessary
    
    * Rename exported api package name
    
    * Review comments
    
    * Export other missing types
    
    * Upgrade api-documenter to latest beta
    
    * Export more missing types
    
    * Fix warnings and add api-exporter to Jenkins tests
    
    * Correctly handle runBuildTypes() exceptions
    
    * Fix another swallowed exception
    
    * Fix api-extractor warnings after master merge
    rudolf authored and joshdover committed Apr 3, 2019
    Configuration menu
    Copy the full SHA
    d2ba1d0 View commit details
    Browse the repository at this point in the history
  2. Update yarn.lock

    joshdover committed Apr 3, 2019
    Configuration menu
    Copy the full SHA
    85a8093 View commit details
    Browse the repository at this point in the history
  3. Fix erraneous type

    joshdover committed Apr 3, 2019
    Configuration menu
    Copy the full SHA
    7f0550c View commit details
    Browse the repository at this point in the history

Commits on Apr 4, 2019

  1. Revert "Update yarn.lock"

    This reverts commit 85a8093.
    rudolf committed Apr 4, 2019
    Configuration menu
    Copy the full SHA
    b5bf654 View commit details
    Browse the repository at this point in the history
  2. Revert "Fix erraneous type"

    This reverts commit 7f0550c.
    rudolf committed Apr 4, 2019
    Configuration menu
    Copy the full SHA
    8eace83 View commit details
    Browse the repository at this point in the history
  3. Backport elastic#32440

    rudolf committed Apr 4, 2019
    Configuration menu
    Copy the full SHA
    3198a42 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    4338da1 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    bf40ad8 View commit details
    Browse the repository at this point in the history