paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 38 Packages Projects Releases Wiki Activity
24,820 Commits 1 Branch 0 Tags
e56bcbfb0ccaa65d3f4ff21235a1a00a4a5f8389
Commit Graph

343 Commits

Author SHA1 Message Date
Eric Peterson cea6f10b97 Recreate a shell of @backstage/techdocs-common for smooth deprecation process 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2022-03-04 18:47:53 +01:00
Eric Peterson 84a8788794 Move packages/techdocs-common -> plugins/techdocs-node 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2022-03-03 17:43:21 +01:00
Fredrik Adelöw 36aa63022b deprecate EntityName, introduce CompoundEntityRef 
deprecate getEntityName, introduce getCompoundEntityRef

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2022-03-02 21:54:45 +01:00
Jussi Hallila ff0a16fb1a Add techdocs-core plugin to techdocs builder automatically 
Currently users need to modify their mkdocs files to container techdocs-core plugin manually when they want to expose techdocs in Backstage. To have a standardized set of extensions without the need to modify existing files (and possibly pollute alternative/additional mkdocs pipelines) this should be added automatically.

This PR adds a helper function to modify the mkdocs file to contain this plugin if it doesn't exist in the config file.

Co-authored-by: @emmaindal

Signed-off-by: Jussi Hallila <jussi@hallila.com>
 2022-03-01 08:20:40 +01:00
Eric Peterson 022891fe78 Merge pull request #9830 from jeremyguarini/fix_gcs_auth 
Fix authentication with GCS for techdocs
 2022-02-26 17:13:50 +01:00
Jeremy Guarini ac25a0f577 When using GCS for the techdocs storage and not setting the GOOGLE_APPLICATION_CREDENTIALS environment variable, authentication and accessing the bucket fails due to the project ID not being found. 
Relevant log output

```
techdocs error from GCS client library: Unable to detect a Project Id in the current environment.
```

By adding the projectID when initializing the Storage client, this should fix the issue. This current approach expects the project_id to be in the json credentials, which it usually is.

Another option would be to re-add the app-config projectID value back and allow users to specify the projectID that way as well.

Signed-off-by: Jeremy Guarini <jguarini@paloaltonetworks.com>
 2022-02-25 21:10:42 -08:00
Camila Belo c13f768521 refactor(techdocs-common): apply review suggestions 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-24 09:28:08 +01:00
Camila Belo 947dcc465a refactor(techdocs-common): clean up helpers api 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-24 08:41:13 +01:00
Camila Belo 7a9b906ec7 refactor(techdocs-common): clean up publish api 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-24 08:41:13 +01:00
Camila Belo 2f16b943c9 refactor(techdocs-common): clean up preparer api 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-24 08:41:13 +01:00
Camila Belo ced3d7cef8 refactor(techdocs-common): clean up generator api 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-24 08:41:13 +01:00
Camila Belo fe9342e71e chore(techdocs-common): upgrade default docker image 
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2022-02-18 10:19:01 +01:00
Patrik Oldsberg 209fd128e6 removed all references to the removed SCM-specific location types 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2022-02-17 17:46:04 +01:00
Johan Haals 7aeb491394 catalog-model: deprecate ENTITY_DEFAULT_NAMESPACE, replace with DEFAULT_NAMESPACE 
Signed-off-by: Johan Haals <johan.haals@gmail.com>
 2022-02-15 10:27:57 +01:00
Fredrik Adelöw 216725b434 catalog-model: rename parse/stringifyLocationRef 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2022-02-11 17:11:10 +01:00
Oliver Paraskos 46dcbaeb64 Fix interpolated string Failed to generate docs... 
A string was using the wrong kind of quotes and so the interpolated fields weren't.

Signed-off-by: Oliver Paraskos <oliver@tryflux.com>
 2022-01-20 10:52:15 +00:00
Eric Peterson 47277c0d8c Bump @spotify/techdocs container to v0.3.6 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2022-01-17 17:34:01 +01:00
Johan Haals 618d78495c Merge pull request #8825 from backstage/freben/a-tale-of-hyphens-and-braces 
🧹  Got rid of the last brace-typed and hyphen-less params etc
 2022-01-10 14:27:21 +01:00
Fredrik Adelöw 5333451def Got rid of the last brace-typed and hyphen-less params etc 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2022-01-10 09:48:12 +01:00
Fredrik Adelöw 9632cda521 Fix the last renmnants of the old copyright header 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2022-01-09 22:10:52 +01:00
Tim Jacomb 521b806109 Update docs for techdocs runCommand (#8332) 2021-12-09 15:38:48 +01: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
Eric Peterson ef600b3c8c Review feedback. 
Signed-off-by: Eric Peterson <i.am@eric.pe>
 2021-12-05 16:50:09 -06: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
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
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
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
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
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
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