029526ccf0
Fix parseReferenceAnnotation missing annotation error message
...
Signed-off-by: Mike Haley <mike.f.haley@gmail.com >
2025-06-30 23:03:22 -04:00
72d019d663
chore(typos): Fix low-impact typos
...
Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com >
2025-04-23 17:56:22 +02:00
1d55517f79
Fix tsc error.
...
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com >
2025-04-01 14:09:26 -04:00
2d7a3b8731
Update Azure techdocs publisher to pipe file content to res.
...
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com >
2025-04-01 13:41:34 -04:00
304a422ef4
Replace S3 streamToBuffer with pipe. ( #28993 )
...
* Replace S3 streamToBuffer with pipe.
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com >
2025-03-19 09:12:31 -04:00
30d1cbe4d4
bump techdocs generator version
...
Signed-off-by: John Philip <jphilip@spotify.com >
2025-02-14 22:15:13 -05:00
8de3d2d53d
feat(techdocs): add support for AWS S3 retries in publisher ( #28446 )
...
This change is to allow a configurable retry in Backstage TechDocs AWS S3 publisher.
It introduces a new possible option for techdocs-cli publish called --awsMaxAttempts. This configuration when specified as a number translates to maxAttempts that is compatible with aws-sdk/client-s3 (JavaScript v3) S3Client class. The change will not break existing configuration setups - maxAttempts is optional and fallbacks to already existing defaults if not specified.
Signed-off-by: Laimis Juzeliūnas <asnelaimis@gmail.com >
2025-01-14 13:15:16 -05:00
ee8b63def9
use mockServices more
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-12-18 14:14:42 +01:00
fbdc63116c
feat(techdocs): Allow to pass options to GCS publisher ( #26836 )
...
* feat(techdocs): Allow to pass options to GCS publisher
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
---------
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
2024-10-01 13:40:47 -04:00
e94df98f1b
techdocs-node: improved type detection and filtering
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Co-authored-by: Alex Lorenzi <alorenzi@spotify.com >
2024-09-17 14:57:08 +02:00
d995579b11
techdocs-node: improve bucket path handling
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Co-authored-by: Alex Lorenzi <alorenzi@spotify.com >
2024-09-17 13:49:46 +02:00
c72023c5e6
Merge pull request #25543 from SDA-SE/techdocs-node/migrate-container-runner
...
Add TechdocsContainerRunner interface as successor of deprecated ContainerRunner for TechdocsGenerator
2024-09-11 11:53:34 +02:00
02966a3803
Merge pull request #26432 from martina-equinix/martina-equinix/techdocs-yaml-custom-tags
...
fix(techdocs-node): Allow mapping custom tags in mkdocs validator
2024-09-09 13:36:49 -04:00
3606843e44
fixup
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-09-05 15:01:41 +02:00
e6a0d4f7f0
Support mapping custom tags in mkdocs yaml parser (techdocs)
...
Signed-off-by: martina-equinix <martina.iglesias@eu.equinix.com >
2024-09-03 12:10:49 +02:00
f715f5ca71
Move TechdocsContainerRunner interface from publish to generate where it is used
...
Signed-off-by: Jörg Siebahn <joerg.siebahn@sda-se.com >
2024-08-28 14:26:38 +02:00
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
Mike Haley