997998e0e0
refactor: apply review suggestions
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2024-08-26 12:56:35 +02:00
33ebb28942
refactor(techdocs-node): remove dependency on backend-common
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2024-08-26 12:56:35 +02:00
4417dd40d1
Fix typo and unify TechDocs casing in doc strings
...
Signed-off-by: Łukasz Jernaś <lukasz.jernas@allegro.com >
2024-08-19 16:17:27 +02:00
d897ce63d6
Remove backend-common dependency
...
Signed-off-by: Johan Haals <johan.haals@gmail.com >
2024-08-15 13:43:32 +02:00
38f3827e5a
Remove deprecated UrlReaders and update usages
...
Signed-off-by: Johan Haals <johan.haals@gmail.com >
2024-08-15 13:28:21 +02:00
5cedd9f828
Fix TechDocs Edit URL link when trailing slash not present
...
Signed-off-by: Kamil Markow <kamilmarkow@gmail.com >
2024-08-05 13:19:31 -04:00
9559b1ad21
Merge pull request #25772 from backstage/techdocs-common
...
techdocs: introduce common package for annotation constants
2024-07-30 08:38:41 +01:00
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
0afa044555
Update test
...
Update the test that checks that the existing edit_uri value in a
mkdocs.yml won't be overridden by `patchMkdocsYmlPreBuild` so that it
checks the value of 'edit_uri' was not updated rather than just checking
for the existence of the substring. This change is needed because the
substring will exist in the file but as the `repo_url` value which is
expected after the changes in the previous commits.
Signed-off-by: Isabel Tomb <isabelgtomb@gmail.com >
2024-07-23 16:44:55 -05:00
839e888e3a
Add a test for new repo_url edit_uri scenario
...
Add a test that checks that an edit_uri will be generated as expected
if the mkdocs.yml contains a `repo_url` value but no `edit_uri` vlaue.
Signed-off-by: Isabel Tomb <isabelgtomb@gmail.com >
2024-07-23 16:44:54 -05:00
949083ddb4
Update patchMkdocsYmlPreBuild
...
Update the `patchMkdocsYmlPreBuild` function to modify `repo_url` and
`edit_uri` independently of each other. Prior to this change both
`repo_url` and `edit_uri` would have to be missing for either to be
generated which caused an issue in the situation where `repo_url`
is provided in the mkdocs.yml and `edit_uri` is not because the default
`edit_uri` value from mkdocs would be used instead. This value uses `master` as
the branch in the link which breaks the edit link for repos that don't use
`master` as the default branch.
Signed-off-by: Isabel Tomb <isabelgtomb@gmail.com >
2024-07-23 16:44:54 -05:00
25450bab24
Merge pull request #25361 from johnphilip283/add-publisher-extension-point
...
TechDocs: Add publisher extension point
2024-06-26 10:45:27 -04:00
fea739f1ca
fix api reports
...
Signed-off-by: John Philip <jphilip@spotify.com >
2024-06-22 21:14:24 -04:00
779a6777b6
Merge branch 'master' into johnphilip283-patch-1
2024-06-22 13:07:29 -04:00
c17cf4fd23
add publisher extension point
...
Signed-off-by: John Philip <jphilip@spotify.com >
2024-06-22 13:00:35 -04:00
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
f59e1c67d0
techdocs-node: add missing option
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-17 15:51:06 +02:00
d7f9894950
techdocs-node: move default containerRunner init
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-17 13:48:07 +02:00
3bcfbf39d1
techdocs-node: mark as deprecated
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-17 10:28:29 +02:00
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
cc183007ea
Update techdocs.ts container image
...
Signed-off-by: John Philip <johnphilip283@gmail.com >
2024-06-14 17:49:47 -04:00
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
c674ffc164
techdocs-node: do not export ContainerRunner definitions
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-13 15:05:25 +02:00
6e2e5bcce6
techdocs-node: refactor DockerContainerRunner tests
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-13 14:39:05 +02:00
f62d673ae8
techdocs-node: move DockerContainerRunner tests
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-13 14:37:05 +02:00
130d0842a1
techdocs-backend: instantiate containerRunner internally
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-13 14:37:01 +02:00
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
eb34b87d5a
refactor: stop using getVoidLogger in tests
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2024-05-16 09:21:54 +02:00
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
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
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
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
27a4c72396
chore: fix api report
...
Signed-off-by: secustor <sebastian@poxhofer.at >
2024-02-27 22:54:50 +01:00
718b734433
feat(plugins/techdocs): add TechdocsGeneratorExtensionPoint
...
Signed-off-by: secustor <sebastian@poxhofer.at >
2024-02-27 11:42:31 +01:00
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
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
4f773c15f6
Bumped the default TechDocs docker image version
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2023-11-23 13:38:45 -06:00
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
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
29716aa303
Merge pull request #21140 from backstage/freben/arrays-again
...
🧹 another race condition fix
2023-11-09 10:10:13 +01:00
0e8b015a35
another race condition fix
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2023-11-09 09:06:34 +01:00
f32d446679
one more flaky test fixed
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2023-11-08 09:14:42 +01:00
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
b99e29ab8f
refactor(techdocs): deprecate ShouldBuildParameters type
...
Signed-off-by: Phil Kuang <pkuang@factset.com >
2023-10-24 13:06:05 -04:00
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
31fd1146af
Run prettier:fix
...
Signed-off-by: Kamil Zainal <gh@akza.dev >
2023-10-23 15:34:38 +01:00
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
31458f5b63
feat(techdocs): rename extension point
...
Signed-off-by: Phil Kuang <pkuang@factset.com >
2023-10-16 19:10:46 -04:00
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
55bd8c76d1
update after rebase
...
Signed-off-by: Morgan Bentell <mbentell@spotify.com >
2023-10-06 11:21:08 +02:00
Camila Belo