Commit Graph

125 Commits

Author SHA1 Message Date
Andre Wanlin 89d74559df Updated based on feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-07-17 12:26:55 -05:00
Andre Wanlin 2bc1a40cad Added more details as to how to setup events for GitHub discovery
Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Update docs/integrations/github/discovery.md

Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>

Update docs/integrations/github/discovery.md

Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>

Improvements based on feedback

Signed-off-by: Andre Wanlin <awanlin@spotify.com>

Reworded

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-07-17 12:18:02 -05:00
Calle Pettersson 282f6f0e2d Fix github-org extension documentation
Signed-off-by: Calle Pettersson <carlpett@users.noreply.github.com>
2025-07-14 20:01:36 +02:00
Andre Wanlin b5545900a4 Initial removal
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-06-06 13:14:54 -05:00
Ben Lambert a9f3efb187 Merge pull request #29885 from leboncoin/feat-github-minimatch
feat(backend-defaults): use isGlob in GithubUrlReader to match glob patterns
2025-05-13 14:40:43 +02:00
Benjamin Janssens bc7751a74e chore(catalog): rename includeArchived to allowArchived
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2025-05-12 18:06:19 +02:00
Benjamin Janssens ee9f59f3e0 feat(catalog): add filter to include archived repositories
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2025-05-09 11:47:59 +02:00
Thomas Cardonne 1e06afd80c feat(backend-defaults): use isGlob in GithubUrlReader to match glob patterns
Signed-off-by: Thomas Cardonne <t.cardonne@gmail.com>
2025-05-08 12:14:37 +02:00
aramissennyeydd 499fa53939 chore: remove old backend system guides
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-04-28 11:03:06 -07:00
Luke Albao a044efa187 [docs] add branch naming caveat to github discovery integration
Signed-off-by: Luke Albao <luke.albao@webflow.com>
2025-03-28 13:44:09 -07:00
Patrik Oldsberg bc71718834 update docs to remove /alpha
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-10-11 16:50:08 +02:00
Patrik Oldsberg 2f88f88882 docs: remove function call from all backend feature installation instructions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-09-18 15:22:41 +02:00
Camila Belo fc24d9ebf0 refactor: stop using backend-tasks in packages and plugins
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-08-19 15:48:21 +02:00
Andre Wanlin 1145181834 Moved from root note to title
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-13 10:45:17 -05:00
Adam Harvey a835d6f644 chore(docs): Fix broken Note admonition
Signed-off-by: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
2024-07-05 22:40:33 -04:00
Patrick Jungermann 9112efc364 feat(catalog,github): support repository events
The provider adds a subscription to the topic `github.repository`.

Hereby, it supports events of type `repository` with actions

- `archived`
- `deleted`
- `edited`
- `renamed`
- `transferred`
- `unarchived`

Actions skipped as they don't require entity changes:

- `created`
- `privatized`
- `publicized`

If the config option `validateLocationsExist` is enabled, an API request
is necessary and will be executed.
This affects the actions `renamed`, `transferred`, and `unarchive`
of event type `repository`.

Catalog entities related to the `GithubEntityProvider` instance will be adjusted
according to action and its meaning for them.

Closes: #21906
Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
2024-06-25 00:12:12 +02:00
Fredrik Adelöw 71f97ddc83 Merge pull request #24790 from J0shSkqlq/master
[Docs] Describe default Behaviour of branch filter in the Configuration of the Github discovery provider.
2024-06-04 14:04:15 +02:00
Patrik Oldsberg a1ae9cc72c docs: restructure local-dev and rename to tooling
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-05-30 14:28:23 +02:00
Aditya Kumar 67ce37af2c Updated the note format of documents
Signed-off-by: Aditya Kumar <aditya.kumar60@infosys.com>
2024-05-21 09:22:12 +05:30
J0shSkqlq 55ca3f992e add hint about default behaviour of branch filter
I would have expected the Discovery Processor to look at all branches. Having this hint would be nice.

Signed-off-by: J0shSkqlq <103205739+J0shSkqlq@users.noreply.github.com>
2024-05-15 13:53:45 +02:00
J0shSkqlq caf1da5c45 add hint about default behaviour of branch filter (in old backend docs))
I would have expected the Discovery Processor to look at all branches. Having this hint would be nice.

Signed-off-by: J0shSkqlq <103205739+J0shSkqlq@users.noreply.github.com>
2024-05-15 13:52:53 +02:00
Patrik Oldsberg b19dfb38cc docs/integration/github: doc spelling fix + update
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-05-14 11:57:33 +02:00
Vincenzo Scamporlino 07ba7f648e docs: fix vale issue
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-05-14 11:44:52 +02:00
Vincenzo Scamporlino 95ee6d6a24 Merge pull request #24700 from backstage/github-multi-org-fix-namespace
catalog-backend-module-github-org: fix default namespace for groups
2024-05-13 22:10:11 +02:00
JeevaRamanathan e5e1af521a updated document of github, gitlab location
Signed-off-by: JeevaRamanathan <jeevaramanathan.m@infosys.com>
2024-05-13 15:53:17 +05:30
Vincenzo Scamporlino 4cd526e1ea docs: improve migration docs
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2024-05-10 13:45:05 +02:00
Patrik Oldsberg b920a47976 fix multi-line links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-05-10 10:16:00 +02:00
Andre Wanlin 2e14b0e924 Changes based on feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-05-02 08:46:27 -05:00
Andre Wanlin 9814aa6dd4 Updated GitHub Integrations Docs
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-05-02 07:10:22 -05:00
Andre Wanlin c123331ba4 Updated commit status importance
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-05-01 07:46:44 -05:00
Gisela Torres 252b2ebfd4 Update discovery.md
Signed-off-by: Gisela Torres <giselatb@outlook.com>
2024-04-21 23:51:06 +02:00
Patrik Oldsberg 0ebd8a28fd docs/integration/github/discovery: mention require scope and permissions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-04-12 17:25:22 +02:00
Patrick Jungermann 2eb0da3931 feat(events,github-org): add support for EventsService, events at new backend
Adds optional support for the EventsService passed
as argument to the factory method.

For the new backend, the EventsService is used as dependency and passed on.
Events support will be active always.

The support for the deprecated EventBroker and its interfaces was kept for
easier migration and will be removed as a separate follow-up change that
could go into a following release.

Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
2024-03-19 15:01:40 +01:00
Patrick Jungermann bcf55d5ba2 feat(events,github): add support for EventsService, events at new backend
Adds optional support for the EventsService passed
as argument to the factory method.

For the new backend, the EventsService is used as dependency and passed on.
Events support will be active always.

The support for the deprecated EventBroker and its interfaces was kept for
easier migration and will be removed as a separate follow-up change that
could go into a following release.

Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
2024-03-19 14:11:22 +01:00
Aramis a33bd1f7a8 docs: start adding user roles to getting started documentation
Following CNCF guidelines for improved Backstage documentation.

Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-02-17 16:19:02 -05:00
Fredrik Adelöw 9aac2b0d36 move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-04 20:13:00 +01:00
Jake Taylor 57c115c86b Update docs/integrations/github/github-apps.md
Co-authored-by: Frank Kong <50030060+Zaperex@users.noreply.github.com>
Signed-off-by: Jake Taylor <147415933+jrtaylorJH@users.noreply.github.com>
2024-01-16 14:00:49 -06:00
Jake Taylor fe30d25922 Update docs/integrations/github/github-apps.md
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Jake Taylor <147415933+jrtaylorJH@users.noreply.github.com>
2024-01-05 11:21:30 -06:00
Jake Taylor 5de1455df0 Update github-apps.md
Fix indentation

Signed-off-by: Jake Taylor <147415933+jrtaylorJH@users.noreply.github.com>
2024-01-05 10:38:52 -06:00
Jake Taylor 445511769f Update github-apps.md
Provide information on troubleshooting a specific error with GitHub Apps integration

Signed-off-by: Jake Taylor <147415933+jrtaylorJH@users.noreply.github.com>
2024-01-05 10:36:44 -06:00
Alex Crome 6fb909f011 More Backend Migration Docs
* Added more documentation on migrating catalog modules to the new backend system.  (A-Github)
* Tweaked a few existing documentation page to recommend schedules are set via

Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2023-11-15 22:34:25 +00:00
Vincenzo Scamporlino 7ec10602ff catalog-backend-module-github: fix defaultUserTransformer typings
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-10-02 16:58:17 +02:00
Vincenzo Scamporlino 5b74ce4c1f docs: fix UserEntity references
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-09-25 10:04:43 +02:00
Alex Eftimie f9f9123428 Update discovery.md
Signed-off-by: Alex Eftimie <alex.eftimie@getyourguide.com>
2023-06-08 21:41:16 +02:00
Andrew Ochsner 1948845861 add github:environment:create and github:deployKey:create
Signed-off-by: Andrew Ochsner <andrew.ochsner@cognizant.com>
2023-06-02 10:04:07 -05:00
Fredrik Adelöw 4265bb1e8e Merge pull request #17722 from aochsner/feature/scaffolder-github-variables-secrets
Add Repository Variables and Secrets
2023-05-30 09:32:06 +02:00
Fredrik Adelöw 7b9c0fff37 Merge pull request #17927 from mikebryant/m/fix-org-integration-docs
docs: Fix example to not produce validation errors
2023-05-25 12:08:36 +02:00
Andrew Ochsner 03bd3fed1c update doco w/ github token/app permissions
Signed-off-by: Andrew Ochsner <andrew.ochsner@cognizant.com>
2023-05-24 12:13:44 -05:00
Mike Bryant 96d9aee0a9 docs: Fix example to not produce validation errors
The previous approach generated the following error when a user has no emails

```
Processor BuiltinKindsEntityProcessor threw an error while validating the entity user:default/user; caused by TypeError: /spec/profile/email must NOT have fewer than 1 characters - limit: 1
```

Signed-off-by: Mike Bryant <mike.bryant@mettle.co.uk>
2023-05-24 17:41:49 +01:00
Sergey Shevchenko 56575be2a2 docs: Add notes about backstage root dir
Signed-off-by: Sergey Shevchenko <sergeyshevchdevelop@gmail.com>
2023-05-18 10:58:17 +03:00