Commit Graph

259 Commits

Author SHA1 Message Date
Camila Belo 7d58b5331a fix(techdocs-common): adjust azure storage test
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-12 15:24:39 +02:00
Eric Peterson 0c58dd73d0 Merge pull request #6488 from backstage/feat/techdocs-deleted-pages
Remove stale TechDocs artifacts after publishing new version
2021-08-10 18:46:24 +02:00
Eric Peterson c2d6c8054d Publish should not be blocked on inability to list
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-08-09 14:38:33 +02:00
Fredrik Adelöw 923491eece run prettier formatting
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-08-09 11:54:38 +02:00
Camila Belo 822240373e refactor(techdocs-common): use continuation token for listing blob files
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 17:16:42 +02:00
Camila Belo 5486071aa8 test(techdocs-common): cover bulkStorageOperation helper
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 11:52:19 +02:00
Camila Belo 7eef84a040 test(techdocs-common): cover getCloudPathForLocalPath helper
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 10:28:15 +02:00
Camila Belo ab9b315e2a test(techdocs-common): cover getStaleFiles helper
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo 9cf37164b1 test(techdocs-common): cover stale files deletion for Azure
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo 5386bcc989 test(techdocs-common): cover stale files deletion for AWS
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo da705a74e0 test(techdocs-common): cover stale files deletion for GCS
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo caf519f69c fix(techdocs): make aws and gcs tests pass
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo 6f9e155973 fix(techdocs): make azure tests pass
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo fedf69a396 fix(techdocs): remove unused imported module
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Camila Belo 064f8d2487 feat(techdocs): delete stale files when publishing to Azure
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-08-03 09:34:12 +02:00
Otto Sichert 06b507283b WIP: Remove stale TechDOcs files from AWS
Signed-off-by: Otto Sichert <git@ottosichert.de>
2021-08-03 09:34:12 +02:00
Otto Sichert be87bc0584 Remove stale TechDocs artifacts after publishing new version for GCS
Co-authored-by: Camila Belo <camilaibs@gmail.com>
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Otto Sichert <git@ottosichert.de>
2021-08-03 09:34:12 +02:00
Eric Peterson 8ef28f5dbc Remove all legacy preparer code and dependencies.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-28 18:45:51 +02:00
Eric Peterson aa4c00f4be Merge pull request #6634 from backstage/mob/yaml-support
[TechDocs] Add support for mkdocs.yaml
2021-07-28 16:18:05 +02:00
Eric Peterson a85d6df823 Use verbose level when migrating docs so that techdocs-cli will display when --verbose flag is used.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-28 15:39:37 +02:00
Eric Peterson 45ac799537 Fix path
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-28 15:14:11 +02:00
Eric Peterson 93b689486b Add explicit support for mkdocs.yaml files when present.
Co-authored-by: Camila Loiola <camilaibs@gmail.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-28 14:51:46 +02:00
Dominik Henneke 296d8e3832 Delete obsolete changes
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-21 15:18:38 +02:00
Dominik Henneke d591b764d0 Remove the short-form annotation and only support the full dir:. option
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-21 15:13:16 +02:00
Dominik Henneke f1ebedb421 Merge remote-tracking branch 'upstream/master' into feat/relative-ref-tmp 2021-07-21 12:16:14 +02:00
Himanshu Mishra c8dbc9aaa1 techdocs: add a helpful link to docs page for warning
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-20 12:42:04 +02:00
Phil Kuang 6e5aed1c99 fix(techdocs): properly validate mkdocs docs_dir property
Signed-off-by: Phil Kuang <pkuang@factset.com>
2021-07-16 15:04:33 -04:00
Dominik Henneke d32d01e5bc Introduce the annotation backstage.io/techdocs-ref: <relative-target> as an alias for backstage.io/techdocs-ref: dir:<relative-target>
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-16 10:16:32 +02:00
Eric Peterson 54c25db339 Merge pull request #6071 from andrewthauer/techdocs-custom-docker
feat(techdocs-common): add custom docker image support
2021-07-15 10:39:14 +02:00
Eric Peterson ef4a4cdefd Merge pull request #6341 from SDA-SE/feat/techdocs-build-logs 2021-07-14 23:30:15 +02:00
Camila Belo 3b3729f299 Throws an error when there is no triplet
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-07-14 14:05:16 +02:00
Andrew Thauer d5eaab91dd feat(techdocs-common): add custom docker image support
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
2021-07-13 11:26:17 -04:00
Eric Peterson 34efce9c44 Apply helper to local, just to be consistent.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:50:33 +02:00
Eric Peterson 567c95284f Move AWS policy docs to documentation page.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:50:33 +02:00
Eric Peterson e8302ea5a4 Use move instead of copy in GCS migrate when requested.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:50:33 +02:00
Eric Peterson c23b09d52d Centralize lowercase logic to tested helper.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:50:33 +02:00
Camila Belo d4535da733 Initial Azure migrate method
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-07-13 13:25:37 +02:00
Eric Peterson 6471d21123 Initial AWS migrate method.
Co-authored-by: Camila Belo <camilabs@gmail.com>
Co-authored-by: Ruben Lindström <rubenl@spotify.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:25:36 +02:00
Eric Peterson 8fa94e3acc Google Cloud Storage implementation
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:25:36 +02:00
Eric Peterson 8b653ba877 Local implementation just for illustrative purposes.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:25:36 +02:00
Eric Peterson 495a935f1f Define migration interface.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-07-13 13:25:36 +02:00
Dominik Henneke 800445cca0 Move the logging one level up to send all logs and exceptions to the user
With this change, only failed builds are logged to the backend logger

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-09 14:33:54 +02:00
Dominik Henneke c18e8eb910 Provide an optional logStream: Writable argument to the GeneratorBase#run(...) command
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-07-05 14:20:41 +02:00
Himanshu Mishra a22de797bf Merge pull request #6206 from Dorn-/fix/openstack-publisher-encoding
fix(techdocs-commons): remove utf8 encoding on openstack publisher
2021-07-02 15:54:29 +02:00
Patrik Oldsberg 0ce80ab75a Merge pull request #6204 from backstage/rugvip/safety
backend-common,cli-common: new utilites for safely resolving child paths
2021-06-29 09:43:01 +02:00
Patrik Oldsberg ab5cc376fa backend-common,cli-common: new utilites for safely resolving child paths
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-28 22:35:21 +02:00
Fredrik Adelöw 4666577b53 Merge pull request #6141 from backstage/software-catalog-rename
Docs: Update references to "service catalog"
2021-06-28 13:47:16 +02:00
Flavien Chantelot 683308ecf8 fix: remove utf8 encoding on openstack publisher
The utf8 encoding, which was not setted for other cloud storage providers, broke all images and other binary files.
The files uploaded were unreadable except plain text files. So in a standard documentation, all images were broken

Signed-off-by: Flavien Chantelot <flavien.chantelot@ovhcloud.com>
2021-06-28 11:24:28 +02:00
Fredrik Adelöw bd9821e52e Merge pull request #6130 from RoadieHQ/docs_dir_traversal
Add check against directory traversal for `docs_dir` config value
2021-06-24 11:20:20 +02:00
Joe Porpeglia 709589a839 Rename service catalog to software catalog, excluding blog posts
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2021-06-21 11:48:43 -04:00