Commit Graph

427 Commits

Author SHA1 Message Date
github-actions[bot] 3d68c45ef7 Version Packages 2021-12-23 12:23:34 +00:00
Tim Jacomb 521b806109 Update docs for techdocs runCommand (#8332) 2021-12-09 15:38:48 +01:00
github-actions[bot] 9068128fd8 Version Packages 2021-12-09 12:02:28 +00:00
Fredrik Adelöw dcd1a0c3f4 Do not unpack arguments directly on exported items
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-12-07 19:42:10 +01:00
Emma Indal 594e73aa1c use path.sep instead of / to accound for differnt platforms (#8380)
Signed-off-by: Emma Indal <emmai@spotify.com>
2021-12-06 14:29:07 +01:00
Otto Sichert 731e9293bd Merge pull request #6335 from backstage/iameap/techdocs-cache
[TechDocs] Optional static resource caching
2021-12-06 10:38:30 +01:00
Eric Peterson ef600b3c8c Review feedback.
Signed-off-by: Eric Peterson <i.am@eric.pe>
2021-12-05 16:50:09 -06:00
github-actions[bot] 29f2606ed9 Version Packages 2021-12-02 12:35:24 +00:00
Eric Peterson dcabc18f7e Fix tests after rebase.
Signed-off-by: Eric Peterson <i.am@eric.pe>
2021-11-28 13:44:21 -07:00
Eric Peterson 6e9e82b99d Review feedback.
Signed-off-by: Eric Peterson <i.am@eric.pe>
2021-11-28 13:40:51 -07:00
Eric Peterson 12157e8f5b Fix up tests after rebase.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson 6e618bef06 Fix up types/tests/report.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson e99606d3e6 Add all generated files to techdocs_metadata.json
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson 693db1da54 Review feedback.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson 790f02c898 Improve types/documentation.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson 8b438c7717 Update all Publishers so that they resolve a list of objects on successful publish.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
github-actions[bot] ef34f5de7b Version Packages 2021-11-25 12:40:52 +00:00
Otto Sichert b23bc7f9c3 Change default port of backend to 7007 due to MacOS Control Center update
Signed-off-by: Otto Sichert <git@ottosichert.de>
2021-11-18 16:45:57 +01:00
github-actions[bot] 99bf179ccf Version Packages 2021-11-18 11:52:08 +00:00
Eric Peterson 7439368ce5 Merge pull request #7917 from mertcb/migrate/oss 2021-11-17 08:44:42 +01:00
Eric Peterson b0c7748ab5 Ensure sse config is optional; pass through sse from constructor.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-16 10:34:56 +01:00
Mert Can Bilgiç 35acef9931 Merge branch 'master' into migrate/oss 2021-11-16 10:27:39 +03:00
therynamo 7acc18e21a feat: Allow SSE on AWS S3 Buckets
Signed-off-by: therynamo <theryn.groetken@gemini.com>
2021-11-15 10:56:13 -06:00
github-actions[bot] 3369ade8c0 Version Packages 2021-11-11 11:07:58 +00:00
Mert Can Bilgiç 884c6d0bc5 prettier runned
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-11-10 13:28:22 +03:00
Mert Can Bilgiç 41e5f28ab7 OSS lowercase migration added
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-11-10 13:28:22 +03:00
Patrik Oldsberg 12eaaaba28 Merge pull request #7851 from cmpadden/publisher-object-pattern
Use Parameter Objects for Publisher Constructors
2021-11-09 20:38:37 +01:00
Andre Wanlin 7240d33df3 Also fixing for Google Storage
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2021-11-03 07:30:56 -05:00
Andre Wanlin 4848c9cb20 Fixed other instances of same issue
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2021-10-31 19:58:51 -05:00
Andre Wanlin 777daa10ad Fixed s3 path join to work under any os
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2021-10-31 19:56:06 -05:00
Colton Padden a2d4389587 Use Parameter Objects for Publisher Constructors
Refactored Techdocs publishers to use a single parameter object as the
constructor argument to ease extendability as more options are introduced.

Updated local publisher to use `.fromConfig` for instantiation so that it
follows the same design pattern as the other publishers.

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-31 11:15:47 -04:00
Eric Peterson 6129c89a47 Bump TechDocs container to v0.3.5.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-29 11:48:39 +02:00
github-actions[bot] d66c5f1282 Version Packages 2021-10-28 14:06:43 +00:00
Eric Peterson cfd54b9af4 Fix TechDocs common bug (and tests) on windows.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-26 17:41:53 +02:00
Eric Peterson d066399739 Merge pull request #7554 from cmpadden/techdocs-storage-subfolder
Support optional bucketRootPath in GCS and S3 techdocs publishers
2021-10-25 15:34:10 +02:00
Colton Padden 109a66a7c7 make bucketRootPath the last argument to publish constructors
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-21 09:42:52 -04:00
github-actions[bot] bf5090e59d Version Packages 2021-10-21 13:28:13 +00:00
Patrik Oldsberg 1455f4e693 techdocs-common: fix helper tests on windows
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-20 23:53:29 +02:00
Camila Belo 4a7d47c020 Merge pull request #7080 from backstage/vinzscam/techdocs-use-readme-as-fallback
techdocs: use README.md as index fallback
2021-10-20 22:04:46 +02:00
Vincenzo Scamporlino 59b45a4396 Add checks for warnings
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2021-10-20 13:34:00 +02:00
Vincenzo Scamporlino 2bc10af8a4 fix comments
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2021-10-20 13:12:31 +02:00
Patrik Oldsberg de48939447 Merge pull request #7461 from backstage/rugvip/errors
[PRFC] errors: add isError, assertError and ErrorLike type
2021-10-20 13:07:49 +02:00
Patrik Oldsberg f316d05889 Merge pull request #7649 from backstage/rugvip/noglobals
techdocs-common: avoid global type declarations
2021-10-19 12:53:46 +02:00
Vincenzo Scamporlino bca27b3662 techdocs: use README.md as index fallback
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2021-10-19 10:47:29 +02:00
Camila Belo 7f7057eb6a docs(techdocs-common): update api reports
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-10-18 19:39:38 +02:00
Camila Belo dfd03b5aa6 chore(techdocs-common): bump default docker image
A new release of `techdocs-container` has been published and as recommended [here](https://github.com/backstage/techdocs-container#release) the default container image used by the Techdocs Generator has been changed.

Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-10-18 18:38:23 +02:00
Patrik Oldsberg b81299a332 techdocs-common: avoid global type declarations
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-17 15:25:57 +02:00
Patrik Oldsberg 36e67d2f24 more strict error type checking in most packages and backend plugins
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-17 15:09:05 +02:00
Colton Padden d207f6ee9e Support optional bucketRootPath in GCS and S3 techdocs publishers
- Updated app-config.yaml with additional configuration parameters:
    - techdocs.publisher.awsS3.bucketRootPath
    - techdocs.publisher.googleGcs.bucketRootPath
- Updated `fromConfig` and constructors to support additional `bucketRootPath`
  parameters.
- Updated publish method to support `bucketRootPath` in constructing destination
  file path
- Updated `fetchTechDocsMetadata` to use `bucketRootPath`
- Updated `docsRouter` to use `docsRouter` when retrieving files
    - When using both legacy casing, and a bucket root path, additional logic
      was added to prevent the root path's case from being modified as
      previously legacy casing would be applied to the first three entities of
      the URI
- Updated `hasDocsBeenGenerated` to use `bucketRootPath`
- Added additional unit tests for new configurations to updated, and new methods

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-11 10:49:40 -04:00
github-actions[bot] 97420439e1 Version Packages 2021-10-07 12:17:39 +00:00