Adds gitea to supported set of SCM integrations

Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> GiteaUrlReader readUrl implementation. Currently relies on content being base64 encoded Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Prettify changed files Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Changeset for gitea integration Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Include gitea in Vale vocabulary, run Lint / Prettier Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Update api-reports Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Lint packages/integration/* Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Fix getGiteaFileContentsUrl, split changesets The previous file contents url code was missing a segment, (/branch), and was causing the loader to 404. (The intended functionality is to use the same URL you would use to view the file in gitea) Changesets for the integration and backend-common packages were split This commit also adds documentation relevant to the gitea integration Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com> Signed-off-by: Pedro Cardona <1724279+atoko@users.noreply.github.com>
2022-10-09 19:42:27 -04:00
parent 4a6143a3be
commit d05e1841ce
22 changed files with 1086 additions and 1 deletions
@@ -0,0 +1,38 @@
+---
+id: locations
+title: Gitea Locations
+sidebar_label: Locations
+description: Integrating source code stored in Gitea into the Backstage catalog
+---
+
+The Gitea integration supports loading catalog entities from a hosted repository. Entities can be added to
+[static catalog configuration](../../features/software-catalog/configuration.md),
+registered with the
+[catalog-import](https://github.com/backstage/backstage/tree/master/plugins/catalog-import)
+plugin.
+
+## Configuration
+
+To use this integration, add configuration to your root `app-config.yaml`:
+
+```yaml
+integrations:
+  gitea:
+    - host: gitea.example.com
+      password: ${GITEA_TOKEN}
+    - host: gitea.example.com
+      username: ${GITEA_USERNAME}
+      password: ${GITEA_PASSWORD}
+```
+
+Directly under the `gitea` key is a list of provider configurations, where you
+can list the Gitea instances you want to be able to fetch
+data from. Each entry is a structure with up to four elements:
+
+- `host`: The host of the gitea instance that you want to match on.
+- `baseUrl` (optional): Needed if the Gitea instance is not reachable at
+  the base of the `host` option (e.g. `https://git.company.com/gitea`). This is the address that you would open in a browser.
+- `username` (optional): The gitea username to use in API requests.
+- `password` (optional): The password or api token to authenticate with.
+
+You may supply only the `password` field, if authenticating via API access tokens (generated in Settings > Applications).