paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
fa6c767fff205a4fe7efa4688e7cbd89119bfc38
backstage/packages/techdocs-cli/CHANGELOG.md
T
github-actions[bot] f0196a2f04 Version Packages
2022-10-18 09:55:10 +00:00

18 KiB
Raw Blame History

@techdocs/cli

1.2.2

Patch Changes

  • 0b2a30dead: fixing techdocs-cli Docker client creation

    Docker client does not need to be created when --no-docker option is provided.

    If you had DOCKER_CERT_PATH environment variable defined the Docker client was looking for certificates and breaking techdocs-cli generate command even with --no-docker option.

  • Updated dependencies

    • @backstage/catalog-model@1.1.2
    • @backstage/backend-common@0.15.2
    • @backstage/plugin-techdocs-node@1.4.1
    • @backstage/cli-common@0.1.10
    • @backstage/config@1.0.3

1.2.2-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.15.2-next.2
    • @backstage/plugin-techdocs-node@1.4.1-next.2
    • @backstage/catalog-model@1.1.2-next.2
    • @backstage/cli-common@0.1.10
    • @backstage/config@1.0.3-next.2

1.2.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.15.2-next.1
    • @backstage/catalog-model@1.1.2-next.1
    • @backstage/cli-common@0.1.10
    • @backstage/config@1.0.3-next.1
    • @backstage/plugin-techdocs-node@1.4.1-next.1

1.2.2-next.0

Patch Changes

  • 0b2a30dead: fixing techdocs-cli Docker client creation

    Docker client does not need to be created when --no-docker option is provided.

    If you had DOCKER_CERT_PATH environment variable defined the Docker client was looking for certificates and breaking techdocs-cli generate command even with --no-docker option.

  • Updated dependencies

    • @backstage/catalog-model@1.1.2-next.0
    • @backstage/plugin-techdocs-node@1.4.1-next.0
    • @backstage/backend-common@0.15.2-next.0
    • @backstage/cli-common@0.1.10
    • @backstage/config@1.0.3-next.0

1.2.1

Patch Changes

  • 7d47def9c4: Removed dependency on @types/jest.
  • Updated dependencies
    • @backstage/backend-common@0.15.1
    • @backstage/plugin-techdocs-node@1.4.0
    • @backstage/catalog-model@1.1.1
    • @backstage/cli-common@0.1.10
    • @backstage/config@1.0.2

1.2.1-next.2

Patch Changes

  • 7d47def9c4: Removed dependency on @types/jest.
  • Updated dependencies
    • @backstage/catalog-model@1.1.1-next.0
    • @backstage/cli-common@0.1.10-next.0
    • @backstage/config@1.0.2-next.0
    • @backstage/backend-common@0.15.1-next.3
    • @backstage/plugin-techdocs-node@1.4.0-next.2

1.2.1-next.1

Patch Changes

1.2.1-next.0

Patch Changes

1.2.0

Minor Changes

  • 855952db53: Added CLI option --docker-option to allow passing additional options to the docker run command executed my serve and serve:mkdocs.

Patch Changes

1.2.0-next.2

Minor Changes

  • 855952db53: Added CLI option --docker-option to allow passing additional options to the docker run command executed my serve and serve:mkdocs.

1.1.4-next.1

Patch Changes

1.1.4-next.0

Patch Changes

1.1.3

Patch Changes

  • a5d73da942: Fix the flag parsing for legacyCopyReadmeMdToIndexMd in techdocs-cli generate command, and decouple it's logic from the techdocs-ref flag.
  • 14ce0d9347: Fixed a bug that prevented docker images from being pulled by default when generating TechDocs.
  • Updated dependencies

1.1.3-next.1

Patch Changes

  • a5d73da942: Fix the flag parsing for legacyCopyReadmeMdToIndexMd in techdocs-cli generate command, and decouple it's logic from the techdocs-ref flag.
  • Updated dependencies

1.1.3-next.0

Patch Changes

  • 14ce0d9347: Fixed a bug that prevented docker images from being pulled by default when generating TechDocs.
  • Updated dependencies

1.1.2

Patch Changes

  • f96e98f4cd: Updated dependency cypress to ^10.0.0.
  • bff65e6958: Updated sidebar-related logic to use <SidebarPinStateProvider> + useSidebarPinState() and/or <SidebarOpenStateProvider> + useSidebarOpenState() from @backstage/core-components.
  • Updated dependencies

1.1.2-next.2

Patch Changes

1.1.2-next.1

Patch Changes

  • bff65e6958: Updated sidebar-related logic to use <SidebarPinStateProvider> + useSidebarPinState() and/or <SidebarOpenStateProvider> + useSidebarOpenState() from @backstage/core-components.
  • Updated dependencies

1.1.2-next.0

Patch Changes

1.1.1

Patch Changes

  • 344ea56acc: Bump commander to version 9.1.0
  • 52fddad92d: The TechDocs CLI's embedded app now imports all API refs from the @backstage/plugin-techdocs-react package.
  • c14e78a367: Update techdocs-cli serve's proxyEndpoint to match the base URL of the embedded techdocs app.
  • Updated dependencies
    • @backstage/backend-common@0.13.3
    • @backstage/cli-common@0.1.9
    • @backstage/config@1.0.1
    • @backstage/plugin-techdocs-node@1.1.1
    • @backstage/catalog-model@1.0.2

1.1.1-next.2

Patch Changes

  • Updated dependencies
    • @backstage/backend-common@0.13.3-next.2
    • @backstage/cli-common@0.1.9-next.0
    • @backstage/config@1.0.1-next.0
    • @backstage/catalog-model@1.0.2-next.0
    • @backstage/plugin-techdocs-node@1.1.1-next.1

1.1.1-next.1

Patch Changes

1.1.1-next.0

Patch Changes

1.1.0

Minor Changes

  • 733187987b: Removed an undocumented, broken behavior where README.md files would be copied to index.md if it did not exist, leading to broken links in the TechDocs UI.

    WARNING: If you notice 404s in TechDocs after updating, check to make sure that all markdown files referenced in your mkdocs.ymls' nav sections exist. The following flag may be passed to the generate command to temporarily revert to the broken behavior.

    techdocs-cli generate --legacyCopyReadmeMdToIndexMd

Patch Changes

  • 230ad0826f: Bump to using @types/node v16
  • eb470ea54c: Adds a new flag to override the entrypoint when using a custom docker image. It could be used to reuse existing images with different entrypoints.
  • Updated dependencies

1.1.0-next.1

Minor Changes

  • bcf1a2496c: BREAKING: The default Techdocs behavior will no longer attempt to copy docs/README.md or README.md to docs/index.md (if not found). To retain this behavior in your instance, you can set the following config in your app-config.yaml:

    techdocs:
  generator:
    mkdocs:
      legacyCopyReadmeMdToIndexMd: true

Patch Changes

  • 230ad0826f: Bump to using @types/node v16
  • eb470ea54c: Adds a new flag to override the entrypoint when using a custom docker image. It could be used to reuse existing images with different entrypoints.
  • Updated dependencies

1.0.1-next.0

Patch Changes

  • Updated dependencies

1.0.0

Major Changes

  • b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our versioning policy.

Patch Changes

  • Updated dependencies

0.8.17

Patch Changes

0.8.17-next.0

Patch Changes

0.8.16

Patch Changes

0.8.15

Patch Changes

0.8.14

Patch Changes

0.8.13

Patch Changes

0.8.13-next.0

Patch Changes

0.8.12

Patch Changes

0.8.12-next.1

Patch Changes

0.8.12-next.0

Patch Changes

  • 14472509a3: Use a local file dependency for techdocs-cli-embedded-app, to ensure that it's always pulled out of the workspace

0.8.11

Patch Changes

0.8.11-next.0

Patch Changes

0.8.10

Patch Changes

0.8.9

Patch Changes

0.8.8

Patch Changes

0.8.7

Patch Changes

  • e7230ef814: Bump react-dev-utils to v12
  • Updated dependencies
    • @backstage/backend-common@0.9.12

0.8.6

Patch Changes

  • e21e3c6102: Bumping minimum requirements for dockerode and testcontainers
  • 1578ad341b: Add support for specifying bucketRootPath for AWS and GCS publishers
  • f2694e3750: Adds ability to use encrypted S3 buckets by utilizing the SSE option in the AWS SDK
  • Updated dependencies

0.8.5

Patch Changes

  • Reunified the techdocs-cli monorepo code back into the main backstage repo

    See 7288). The changes include some internal refactoring that do not affect functionality beyond the local development setup.

0.8.4

Patch Changes

  • 8333394: The change updated the @backstage/techdocs-common from version 0.9.0 to 0.10.2 and one of the intermediate versions, the 0.10.0, introduced the use of search in context that requires an implementation for the Search API.

    Created a custom techdocs page to disable search in the Reader component, preventing it from using the Search API, as we don't want to provide search in preview mode.

0.8.3

Patch Changes

  • edbb988: Upgrades the techdocs common page to the latest version 0.10.2.

    See @backstage/techdocs-common changelog.

  • db4ebfc: Add an etag flag to the generate command that is stored in the techdocs_metadata.json file.

0.8.2

Patch Changes

  • 8fc7384: Allow to execute techdocs-cli serve using docker techdocs-container on Windows

0.8.1

Patch Changes

  • 0187424: Separate build and publish release steps

0.8.0

Minor Changes

Patch Changes

  • 05f0409: Merge Jobs for Release Pull Requests and Package Publishes

0.7.0

Minor Changes

  • 9d1f8d8: The techdocs-cli publish command will now publish TechDocs content to remote storage using the lowercase'd entity triplet as the storage path. This is in line with the beta release of the TechDocs plugin (v0.11.0).

    If you have been running techdocs-cli prior to this version, you will need to follow this migration guide.

0.6.2

Patch Changes

  • f1bcf1a: Changelog (from v0.6.1 to v0.6.2)

    🐛 Bug Fix

    • techdocs-cli
      • #105 Add azureAccountKey parameter back to the publish command (@emmaindal)

    🏠 Internal

    • techdocs-cli-embedded-app
      • #122 chore(deps-dev): bump @types/node from 12.20.20 to 16.7.1 in /packages/techdocs-cli-embedded-app (@dependabot[bot])
      • #120 chore(deps-dev): bump @types/react-dom from 16.9.14 to 17.0.9 in /packages/techdocs-cli-embedded-app (@dependabot[bot])
      • #119 chore(deps-dev): bump @testing-library/user-event from 12.8.3 to 13.2.1 in /packages/techdocs-cli-embedded-app (@dependabot[bot])
      • #118 chore(deps-dev): bump @testing-library/react from 10.4.9 to 12.0.0 (@dependabot[bot])
    • Other

    Committers: 3

    Thank you for contributing ❤️

Reference in New Issue View Git Blame Copy Permalink