Commit Graph

106 Commits

Author SHA1 Message Date
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
Patrik Oldsberg b160cb5551 techdocs-node: refactor publish local test to avoid mock-fs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 17:49:24 +02:00
Patrik Oldsberg 8f773cfd02 techdocs-node: refactor publish helpers test to avoid mock-fs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 17:12:00 +02:00
Patrik Oldsberg eace331db0 techdocs-node: refactor generate helpers test to avoid mock-fs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-04 17:10:06 +02:00
Patrik Oldsberg 6246571911 test fixes for Node.js v20
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-09-20 12:58:36 +02:00
Aswath S 0de6b837f4 Merge branch 'backstage:master' into feat/techdocs-azurite-support 2023-08-24 20:51:59 +05:30
titanventura c258bd395f Refactored azureBlobStorage, changelog, techdocs-backend config
Signed-off-by: titanventura <aswath7862001@gmail.com>
2023-08-22 23:22:37 +05:30
titanventura 7284a2e68b Changed 'techdocs.publisher.azureBlobStorage.azuriteConnectionString' to 'techdocs.publisher.azureBlobStorage.connectionString'
Signed-off-by: titanventura <aswath7862001@gmail.com>
2023-07-29 15:49:17 +05:30
titanventura 5985d458ee Added azurite connection string option to techdocs azureBlobStorage publisher
Signed-off-by: titanventura <aswath7862001@gmail.com>
2023-07-27 23:46:37 +05:30
Dominik Schwank 10a86bd4ae feat: support custom default plugins for techdocs
Signed-off-by: Dominik Schwank <dominik.schwank@sda.se>
2023-07-26 13:42:20 +02:00
Morgan Bentell 7d4a09304f use latest techdocs docker image by default
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-05-22 11:56:57 +02:00
Adam Harvey 87a0b37aa7 refactor: Variable typo
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-04-29 13:58:49 -04:00
Morgan Bentell 0e30c231e6 use spotify/techdocs:v1.2.0
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-03-23 11:26:52 +01:00
Fredrik Adelöw 014e41add3 try to fix windows build error
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-03-07 10:20:57 +01:00
Fredrik Adelöw 65454876fb unpack props inside component bodies
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-02-27 15:31:15 +01:00
Morgan Bentell 7e2fc35df2 Merge pull request #16519 from JosiahCraw/feature/add-proxy-support-for-techdocs-awsS3
feat: add support for HTTPS proxy for AWS S3 requests in Techdocs
2023-02-27 09:38:39 +01:00
Jos Craw ea2bbef1b1 feat: add support for HTTPS proxy for AWS S3 requests in Techdocs
Signed-off-by: Jos Craw <me.joscraw@gmail.com>
2023-02-22 21:52:03 +13:00
Knut Borchers bfe350ef4c fix: Prevent deletion of non-empty directories
Signed-off-by: Knut Borchers <knut.borchers@gmail.com>
2023-02-18 18:02:46 +01:00
Renan Mendes Carvalho c5d51ad7d4 renaming(mkDocs): To mkdocs
Suggested by kmatyukhin on https://github.com/backstage/backstage/pull/15417

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>
Co-authored-by: Konstantin Matyukhin <kmatyukhin@gmail.com>
2023-02-14 11:16:22 +01:00
Renan Mendes Carvalho d746d81bdd renaming(getMkDocsYml): Renamed to getMkdocsYml
Suggested by kmatyukhin on https://github.com/backstage/backstage/pull/15417

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>
Co-authored-by: Konstantin Matyukhin <kmatyukhin@gmail.com>
2023-02-14 11:16:22 +01:00
Andre Wanlin 37c17ab92c Handle deleting temportary mkdocs.yml
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin c2bba4affe Rename configExists to configIsTemporary
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin 8e11504ce3 Use object for YAML file
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00