Document GitHub apps/integrations (#1845)

* document github apps for #1844 * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Update tools/github/README.md Co-authored-by: Severin Neumann <[email protected]> * Apply suggestions from code review Co-authored-by: Severin Neumann <[email protected]> * Update README.md Co-authored-by: Trask Stalnaker <[email protected]> * update * fix link --------- Co-authored-by: Severin Neumann <[email protected]> Co-authored-by: Severin Neumann <[email protected]> Co-authored-by: Trask Stalnaker <[email protected]>
open-telemetry · Jul 16, 2024 · 9c776f3 · 9c776f3
1 parent a15bfc0
commit 9c776f3
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 13 deletions.
diff --git a/.cspell.yaml b/.cspell.yaml
@@ -1,20 +1,20 @@
 version: 0.2
-ignorePaths: ["elections/**/*"]
+ignorePaths: ["elections/**/*", "tools/github/*"]
 # Ignore certain patterns in the sigs.yml file
 patterns:
-    - name: Slack Channel ID
-      pattern: "id: [A-Z0-9]{11}"
-    - name: Google Docs ID
-      pattern: "value: [a-zA-Z0-9-_]+"
-    - name: "GitHub Handle"
-      pattern: "@[a-zA-Z0-9-_]+\\b"
-    - name: "GitHub Handle in YML"
-      pattern: "github: [a-zA-Z0-9-_]+"
+  - name: Slack Channel ID
+    pattern: "id: [A-Z0-9]{11}"
+  - name: Google Docs ID
+    pattern: "value: [a-zA-Z0-9-_]+"
+  - name: "GitHub Handle"
+    pattern: "@[a-zA-Z0-9-_]+\\b"
+  - name: "GitHub Handle in YML"
+    pattern: "github: [a-zA-Z0-9-_]+"
 ignoreRegExpList:
-    - Slack Channel ID
-    - Google Docs ID
-    - GitHub Handle
-    - GitHub Handle in YML
+  - Slack Channel ID
+  - Google Docs ID
+  - GitHub Handle
+  - GitHub Handle in YML
 words:
     - Collibra
     - DASD

diff --git a/tools/github/README.md b/tools/github/README.md
@@ -0,0 +1,24 @@
+# GitHub Applications and Integrations
+
+This document and directory contain information about all configured GitHub
+applications and integrations with the OpenTelemetry organization.
+| Name                                                         | Description                                          | Scopes                      | Notes                                                                  |
+|--------------------------------------------------------------|------------------------------------------------------|-----------------------------|------------------------------------------------------------------------|
+| [Allstar App](https://github.com/ossf/allstar)               | Enforces security policies                           | TBD                         | TBD                                                                    |
+| [CircleCI Checks](https://github.com/apps/circleci-checks)   | Integration with CircleCI                            | TBD                         | TBD                                                                    |
+| [Codecov](https://github.com/apps/codecov)                   | Integration with Codecov for PR code coverage checks | TBD                         | TBD                                                                    |
+| [Forking Renovate](https://github.com/apps/forking-renovate) | Dependency updates via Renovate                      | TBD                         | TBD                                                                    |
+| [LFX CM](https://www.crowd.dev/)                             | LFX Community Management                             | Org-wide                    | TBD                                                                    |
+| [EasyCLA](https://github.com/apps/linux-foundation-easycla)  | Required CLA checking from LF                        | Org-wide                    | This must be enabled for all repositories for PRs against main branch. |
+| [Mergify](https://github.com/apps/mergify)                   | TBD                                                  | TBD                         | TBD                                                                    |
+| [Netlify](https://github.com/apps/netlify)                   | Integration with Netlify for website deployments     | opentelemetry.io repository | n/a                                                                    |
+| [Octobox](https://github.com/apps/octobox)                   | TBD                                                  | TBD                         | TBD                                                                    |
+| [OpenShift CI ](https://github.com/apps/openshift-ci)        | TBD                                                  | TBD                         | TBD                                                                    |
+| [Polls](https://github.com/apps/polls)                       | TBD                                                  | TBD                         | TBD                                                                    |
+| [project-bot](https://github.com/apps/project-bot)           | TBD                                                  | TBD                         | TBD                                                                    |
+| [Renovate](https://github.com/apps/renovate)                 | Dependency updates via Renovate                      | TBD                         | TBD                                                                    |
+| [Scope App](https://github.com/apps/scope-app)               | TBD                                                  | TBD                         | TBD                                                                    |
+| [self-actuated](https://actuated.dev/)                       | Integration with Actuated (ARM Runners)              | TBD                         | TBD                                                                    |
+| [Slack](https://github.com/apps/slack)                       | Slack integration for GitHub                         | TBD                         | TBD                                                                    |
+| [Stale](https://github.com/apps/stale)                       | Stale issue bot                                      | Org-wide                    | n/a                                                                    |
+| [Welcome](https://github.com/apps/welcome)                   | TBD                                                  | TBD                         | TBD                                                                    |