Commit Graph

97 Commits

Author SHA1 Message Date
Fredrik Adelöw 7455dae884 require the use of node prefix on native imports
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2026-01-26 13:22:53 +01:00
Patrik Oldsberg ab13a89744 cli-common: polish API surface for run
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-11-30 10:41:06 +01:00
Patrik Oldsberg 43629b128d techdocs-cli: update to use new run utils from cli-common
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-11-30 10:22:59 +01:00
Gabriel Dugny 43afbe50aa feat(techdocs): POC livereload for techdocs-cli serve (#30541)
* feat(techdocs): POC livereload for techdocs-cli serve

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>

* chore: techdocs reload tests, refactor

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>

---------

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>
2025-10-07 13:29:14 -04:00
Patrik Oldsberg 69f84ac4f8 techdocs-cli: fix dynamic imports
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-01-16 17:05:07 +01:00
Laimis Juzeliūnas 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
Fredrik Adelöw c964a3d03c hopefully unbreak backend-common dependencies
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-06-18 22:41:26 +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
Phil Kuang 1a0e009502 fix(techdocs-cli): fix serve cmd with proper cookie endpoint mock
Signed-off-by: Phil Kuang <pkuang@factset.com>
2024-04-18 22:56:53 -04:00
Camila Belo e5f996917d fix: current cookie endpoint path
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-03-25 13:45:54 +01:00
Camila Belo 27c97c0c61 Update packages/techdocs-cli/src/lib/httpServer.ts
Co-authored-by: Vincenzo Scamporlino <vincenzos@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-03-25 10:45:10 +01:00
Camila Belo 1299dd8c1a fix: mock cookie endpoint
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-03-25 10:12:24 +01:00
Gabriel Pereira Woitechen d8d243ca22 fix(techdocs-cli): mkdocs parameter casing
Signed-off-by: Gabriel Pereira Woitechen <wtchnm@icloud.com>
2024-01-02 15:47:47 -03:00
Andre Wanlin e9e57add1b Merge pull request #21403 from hainenber/support-additional-mkdocs-server-cli-params
Support additional mkdocs server cli params
2023-11-24 10:31:55 -06:00
Đỗ Trọng Hải 68ae3df039 Update mkdocsServer.ts
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Đỗ Trọng Hải <41283691+hainenber@users.noreply.github.com>
2023-11-22 00:57:58 +07:00
hainenber 716dd37404 fix(pkg/techdocs): correct dirtyreload arg for mkdocs
Also correct array-like elements for rest operator

Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-21 22:37:02 +07: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
hainenber 69b2f7bf3b fix(techdocs-cli): limit supported mkdocs flags
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-20 21:46:41 +07:00
hainenber 549ca5e3c4 fix(pkg/techdocs-cli): specify new opt
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-20 21:23:10 +07:00
hainenber 5c269df424 feat(pkg/techdocs-cli): support passing additional mkdocs-server CLI parameters when run in containerized mode
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-20 21:23:10 +07:00
hainenber e0815ead2f fix(techdocs-cli): correct returned type
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-11 21:20:06 +07:00
hainenber c9eba082f7 fix(techdocs-cli): expand usage of Docker ops check
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-11 21:13:45 +07:00
hainenber 8ea827797d feat(techdocs-cli): check Docker status before running mkdocs server
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-05 16:02:30 +07: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
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
Dominik Schwank fe81abb8da feat(techdocs-cli): add --defaultPlugin argument to the generate command
Signed-off-by: Dominik Schwank <dominik.schwank@sda.se>
2023-08-22 17:17:48 +02:00
Adam Harvey ba43e4ae35 chore: Remove deprecated imports
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-06-14 20:42:40 -04: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
Morgan Bentell 8e465ce52e print the mkdocs output when running the generate command with the --verbose flag
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-02-22 17:18:35 +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
Morgan Bentell c5c4c91755 Merge pull request #16290 from nikolaik/fix/techdocs-ipv6
fix(techdocs-cli): Fix proxying to mkdocs
2023-02-14 14:34:22 +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
Nikolai R Kristiansen 71f8fc209f fix(techdocs-cli): Fix proxying to mkdocs
The domain localhost may point to both 127.0.0.1 and ::1, ipv4 and ipv6
and when node tries to lookup localhost it might prefer ipv6 while mkdocs
is only listening on ipv4. This tells node-proxy to target the ipv4 address
instead of relying on localhost hostname lookup.

Signed-off-by: Nikolai R Kristiansen <nikolai.kristiansen@remarkable.no>
2023-02-10 13:05:42 +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 c9758fe81e Updated default name and params
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin 943c245b6f Updated to use siteOptions object
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin 15b6eaf533 Large refactor
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Ben Lambert d34c565e43 Merge pull request #15633 from backstage/renovate/prettier-2.x-lockfile
chore(deps): update dependency prettier to v2.8.3
2023-02-06 15:14:05 +01:00
Patrik Oldsberg cbe69fa263 fix formatting
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-01-27 12:05:53 +01:00
Albin Halinen Wilén f39c417bbb Fixed techdocs-cli package publish CLI command having the gcsBucketRootPath option misconfigured, previously returning a boolean vs a string
Signed-off-by: Albin Halinen Wilén <git@alphahw.eu>
2023-01-16 10:27:02 +08:00
Albin Halinen Wilén 6e0b6a0d50 Fixed techdocs-cli package publish CLI command missing awsBucketRootPath option
Signed-off-by: Albin Halinen Wilén <git@alphahw.eu>
2023-01-16 10:20:52 +08:00
Morgan Bentell e7a3ab0b86 Merge pull request #15559 from agentbellnorm/provide-embedded-app-bundle
[TechDocs] Allow user to provide embedded app bundle and specify port
2023-01-10 10:55:52 +01:00
Morgan Bentell ee36ee8d00 fix logic
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-09 16:26:29 +01:00
Morgan Bentell 29113e760a update docs and clean up
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-09 10:03:39 +01:00
Patrik Oldsberg 9f2b786fc9 Avoid directly logging error objects
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-01-07 14:15:17 +01:00
Morgan Bentell 38cdc28135 add --preview-app-port option to serve command
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-05 17:28:26 +01:00
Morgan Bentell bc18c902a2 clean up and update documentation, changeset and cli-report
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-04 15:27:27 +01:00
Morgan Bentell b4db2862a4 Add cli option --preview-app-bundle-path
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-04 15:27:26 +01:00