Commit Graph

128 Commits

Author SHA1 Message Date
MT Lewis 69bd940408 techdocs: switch to using constants from techdocs-common for annotations
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2024-07-24 20:34:59 +01:00
John Philip 25450bab24 Merge pull request #25361 from johnphilip283/add-publisher-extension-point
TechDocs: Add publisher extension point
2024-06-26 10:45:27 -04:00
John Philip fea739f1ca fix api reports
Signed-off-by: John Philip <jphilip@spotify.com>
2024-06-22 21:14:24 -04:00
John Philip 779a6777b6 Merge branch 'master' into johnphilip283-patch-1 2024-06-22 13:07:29 -04:00
John Philip c17cf4fd23 add publisher extension point
Signed-off-by: John Philip <jphilip@spotify.com>
2024-06-22 13:00:35 -04:00
Fredrik Adelöw 25e2394626 Merge pull request #24593 from backstage/techdocs-move-away-from-container-runners
Add Docker container runner to techdocs-node
2024-06-17 17:07:31 +02:00
Vincenzo Scamporlino f59e1c67d0 techdocs-node: add missing option
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-17 15:51:06 +02:00
Vincenzo Scamporlino d7f9894950 techdocs-node: move default containerRunner init
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-17 13:48:07 +02:00
Vincenzo Scamporlino 3bcfbf39d1 techdocs-node: mark as deprecated
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-17 10:28:29 +02:00
Vincenzo Scamporlino e8c01ddc0a techdocs-node: still export ContainerRunner from backend-common
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-17 10:00:52 +02:00
John Philip cc183007ea Update techdocs.ts container image
Signed-off-by: John Philip <johnphilip283@gmail.com>
2024-06-14 17:49:47 -04:00
Calvin Lee 5db753618f fix: enable support for edit_url in TechDocs
Signed-off-by: Calvin Lee <cjlee@ualberta.ca>
2024-06-14 10:56:53 -06:00
Vincenzo Scamporlino c674ffc164 techdocs-node: do not export ContainerRunner definitions
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-13 15:05:25 +02:00
Vincenzo Scamporlino 6e2e5bcce6 techdocs-node: refactor DockerContainerRunner tests
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-13 14:39:05 +02:00
Vincenzo Scamporlino f62d673ae8 techdocs-node: move DockerContainerRunner tests
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-13 14:37:05 +02:00
Vincenzo Scamporlino 130d0842a1 techdocs-backend: instantiate containerRunner internally
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-06-13 14:37:01 +02:00
John Philip 77d6b8cfe3 Merge pull request #24587 from drodil/build_log_transport_extension
feat: allow defining custom build log transport for techdocs
2024-05-29 15:52:45 -04:00
Camila Belo eb34b87d5a refactor: stop using getVoidLogger in tests
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-05-16 09:21:54 +02:00
Camila Belo d229dc49ad refator(backend-common): extract path utilities to plugin api
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-05-13 13:23:45 +02:00
Camila Belo a394b66c3e refator(backend-common): extract test utilities to plugin api
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-05-13 13:15:43 +02:00
Heikki Hellgren e64bfb27cf feat: allow defining custom build log transport for techdocs
should enable way to overcome #24583 memory leak, maybe.

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
2024-05-02 12:08:19 +03:00
Heikki Hellgren 8e28c88656 feat: allow overriding default techdocs preparers
a new extension point `TechdocsPreparerExtensionPoint` allows
registering custom preparers for the techdocs plugin.

closes #21952

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
2024-04-02 13:14:03 +03:00
secustor 27a4c72396 chore: fix api report
Signed-off-by: secustor <sebastian@poxhofer.at>
2024-02-27 22:54:50 +01:00
secustor 718b734433 feat(plugins/techdocs): add TechdocsGeneratorExtensionPoint
Signed-off-by: secustor <sebastian@poxhofer.at>
2024-02-27 11:42:31 +01:00
Jack Murray bdbbd096a6 rewrite patchMkdocsYmlWithPlugins to correctly only merge in all default plugins that are missing
Signed-off-by: Jack Murray <115712715+jackmtpt@users.noreply.github.com>
2024-02-19 11:36:38 +00:00
Jack Murray 3e93fe1bd4 add a failing test to repro the problem
Signed-off-by: Jack Murray <115712715+jackmtpt@users.noreply.github.com>
2024-02-19 11:36:38 +00:00
Andre Wanlin 4f773c15f6 Bumped the default TechDocs docker image version
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2023-11-23 13:38:45 -06:00
Patrik Oldsberg fc92656e42 Merge pull request #20738 from akz08/add-docker-useroptions-bypass
Add a way to bypass user modification for TechDocs CLI docs generation in Docker
2023-11-20 17:41:14 +01:00
Fredrik Adelöw 2ec6199743 oops, deleted too little of the text
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-11-09 10:12:51 +01:00
Fredrik Adelöw 29716aa303 Merge pull request #21140 from backstage/freben/arrays-again
🧹 another race condition fix
2023-11-09 10:10:13 +01:00
Fredrik Adelöw 0e8b015a35 another race condition fix
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-11-09 09:06:34 +01:00
Fredrik Adelöw f32d446679 one more flaky test fixed
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-11-08 09:14:42 +01:00
Fredrik Adelöw a72143c79b Merge pull request #20576 from kuangp/feat/buildStrategyExtension
feat(techdocs): add extension for setting build strategy
2023-10-25 16:45:06 +02:00
Phil Kuang b99e29ab8f refactor(techdocs): deprecate ShouldBuildParameters type
Signed-off-by: Phil Kuang <pkuang@factset.com>
2023-10-24 13:06:05 -04:00
Andrew Ochsner 1d07dcb32c move to @smithy/node-htp-handler as @aws-sdk/node-http-handler is deprecated
Signed-off-by: Andrew Ochsner <andrew.ochsner@cognizant.com>
2023-10-23 16:41:33 -05:00
Kamil Zainal 31fd1146af Run prettier:fix
Signed-off-by: Kamil Zainal <gh@akza.dev>
2023-10-23 15:34:38 +01:00
Kamil Zainal d15d483a49 Expose new option in techdocs cli generate command
The re-assignment of container user on macOS/Linux is troublesome when running on rootless GitHub runners; adding a way to bypass this for generation.

This should be a non-breaking change and just adds functionality.

Signed-off-by: Kamil Zainal <gh@akza.dev>
2023-10-23 15:04:46 +01:00
Phil Kuang 31458f5b63 feat(techdocs): rename extension point
Signed-off-by: Phil Kuang <pkuang@factset.com>
2023-10-16 19:10:46 -04:00
Phil Kuang 67cff7b06f feat(techdocs): add extension for setting build strategy
Signed-off-by: Phil Kuang <pkuang@factset.com>
2023-10-12 18:56:45 -04:00
Morgan Bentell 55bd8c76d1 update after rebase
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-10-06 11:21:08 +02:00
Morgan Bentell 7939e0e64a api report
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-10-06 11:14:45 +02:00
Morgan Bentell d06b30b050 add --mkdocs-config-file-name cli argument to the techdocs-cli serve command
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-10-06 11:14:43 +02:00
John Philip c33f7506f7 Merge pull request #20371 from drodil/custom_preparer_cleanup
feat: allow prepared directory clean up for custom preparers
2023-10-05 19:22:14 -04:00
Patrik Oldsberg 289c224640 backend-common: tweak package path resolution mock API
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-05 13:30:47 +02:00
Heikki Hellgren 344cfbcfbc feat: allow prepared directory clean up for custom preparers
When using custom preparer for TechDocs, the `preparedDir` might
end up taking disk space. This requires all custom preparers to
implement a new method `shouldCleanPreparedDirectory` which indicates
whether the prepared directory should be cleaned after generation.

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
2023-10-05 09:37:10 +03:00
Patrik Oldsberg b074053375 techdocs-node: removed unused fs testing utils
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 23:29:48 +02:00
Patrik Oldsberg 21832cfb8e techdocs-node: refactor awsS3 tests to avoid mock-fs and storage mock
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 23:27:11 +02:00
Patrik Oldsberg ade78cead7 techdocs-node: refactor azureBlobStorage tests to avoid mock-fs and storage mock
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 23:16:49 +02:00
Patrik Oldsberg 9f10308ea1 techdocs-node: refactor googleStorage tests to avoid mock-fs and storage mock
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 22:57:15 +02:00
Patrik Oldsberg f7ab98987a techdocs-node: refactor openStackSwift tests to avoid mock-fs and storage mock
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 22:41:49 +02:00