Skip to content

Commit 20ce4d6

Browse files
verhovskyGTFalcao
andauthored
Spell "GitHub" and "ID" correctly (#18988)
* Spell "GitHub" and "ID" correctly * Update components/github/README.md * Update components/github/README.md --------- Co-authored-by: Guilherme Falcão <48412907+GTFalcao@users.noreply.github.com>
1 parent d20d528 commit 20ce4d6

File tree

23 files changed

+66
-66
lines changed

23 files changed

+66
-66
lines changed

.github/ISSUE_TEMPLATE/new-trigger---event-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: New Trigger / Event Source
33
about: Need to run a workflow on a specific event, like every time a new PR is opened
4-
on Github? Request it here!
4+
on GitHub? Request it here!
55
title: "[TRIGGER]"
66
labels: enhancement, good first issue, help wanted, trigger / source
77
assignees: ''

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Our hope is that by providing a generous free tier, you will not only get value
44

55
## Follow, Star & Subscribe
66

7-
[Follow us](https://twitter.com/pipedream) on Twitter, [star](https://github.com/PipedreamHQ/pipedream) our Github repo and [subscribe](https://www.youtube.com/pipedreamhq) to our YouTube channel.
7+
[Follow us](https://twitter.com/pipedream) on Twitter, [star](https://github.com/PipedreamHQ/pipedream) our GitHub repo and [subscribe](https://www.youtube.com/pipedreamhq) to our YouTube channel.
88

99
## Recommend Us!
1010

@@ -28,7 +28,7 @@ Found an issue? [Report it](https://pipedream.com/community/c/bugs/9)
2828

2929
## Submit & Vote On Feature Requests
3030

31-
Help us build an amazing product! Submit [feature requests](https://pipedream.com/community/c/feature-requests/7) in our community forum, or [browse existing requests](https://github.com/PipedreamHQ/pipedream/issues) on Github and vote for the features want us to add!
31+
Help us build an amazing product! Submit [feature requests](https://pipedream.com/community/c/feature-requests/7) in our community forum, or [browse existing requests](https://github.com/PipedreamHQ/pipedream/issues) on GitHub and vote for the features want us to add!
3232

3333
## Request Apps
3434

@@ -52,7 +52,7 @@ Develop components without leaving your browser with the Pipedream Gitpod worksp
5252

5353
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/PipedreamHQ/pipedream)
5454

55-
1. Fork the official [Pipedream Github Repository](https://github.com/PipedreamHQ/pipedream)
55+
1. Fork the official [Pipedream GitHub repository](https://github.com/PipedreamHQ/pipedream)
5656
2. Add your PD API key to your [Gitpod Variables](https://gitpod.io/variables) as `PD_API_KEY`
5757
3. Open a new Gitpod Workspace with your fork: `https://gitpod.io/#https://github.com/<your-github-username>/pipedream`
5858
4. Run `pd init app` to scaffold a new app, or make changes to an exisiting one in the `components` directory

components/github/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.
44

5-
# Github API Integration Platform
5+
# GitHub API Integration Platform
66

7-
### Connect Github to 2,200+ apps, remarkably fast.
7+
### Connect GitHub to 3,000+ apps, remarkably fast.
88

99
---
1010

@@ -49,7 +49,7 @@ Workflows are a sequence of linear [steps](https://pipedream.com/docs/workflows/
4949
<br />
5050
</p>
5151

52-
## Github API Event Sources ([explore](https://pipedream.com/apps/github))
52+
## GitHub API Event Sources ([explore](https://pipedream.com/apps/github))
5353

5454
[Event Sources](https://pipedream.com/docs/sources/) watch for new data from services like GitHub, Slack, Airtable, RSS and [more](https://pipedream.com/apps). When a source finds a new event, it emits it, triggering any linked workflows.
5555

@@ -99,26 +99,26 @@ export default {
9999

100100
You can find the code for all pre-built sources in [the `components` directory](https://github.com/PipedreamHQ/pipedream/tree/master/components). If you find a bug or want to contribute a feature, [see our contribution guide](https://pipedream.com/docs/components/guidelines/#process).
101101

102-
## Github API Actions ([explore](https://pipedream.com/apps/github))
102+
## GitHub API Actions ([explore](https://pipedream.com/apps/github))
103103

104-
[Actions](https://pipedream.com/docs/components/actions/) are pre-built code steps that you can use in a workflow to perform common operations across Pipedream's 2,000+ API integrations. For example, you can use actions to send email, add a row to a Google Sheet, [and more](https://pipedream.com/apps).
104+
[Actions](https://pipedream.com/docs/components/actions/) are pre-built code steps that you can use in a workflow to perform common operations across Pipedream's 3,000+ API integrations. For example, you can use actions to send email, add a row to a Google Sheet, [and more](https://pipedream.com/apps).
105105

106-
- [Create Issue](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIElzc3VlIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLWNyZWF0ZS1pc3N1ZSJ9XSwiYyI6e319) - Create a new issue in a Gihub repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-issue/create-issue.mjs))
106+
- [Create Issue](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIElzc3VlIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLWNyZWF0ZS1pc3N1ZSJ9XSwiYyI6e319) - Create a new issue in a GitHub repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-issue/create-issue.mjs))
107107
- [Search Issues and Pull Requests](https://pipedream.com/new?h=eyJuIjoiU2VhcmNoIElzc3VlcyBhbmQgUHVsbCBSZXF1ZXN0cyB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1zZWFyY2gtaXNzdWVzLWFuZC1wdWxsLXJlcXVlc3RzIn1dLCJjIjp7fX0) - Find issues and pull requests by state and keyword. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/search-issues-and-pull-requests/search-issues-and-pull-requests.mjs))
108-
- [Create Branch](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIEJyYW5jaCB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1jcmVhdGUtYnJhbmNoIn1dLCJjIjp7fX0) - Create a new branch in a Github repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-branch/create-branch.mjs))
108+
- [Create Branch](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIEJyYW5jaCB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1jcmVhdGUtYnJhbmNoIn1dLCJjIjp7fX0) - Create a new branch in a GitHub repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-branch/create-branch.mjs))
109109
- [Create Gist](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIEdpc3Qgd2l0aCB0aGUgR2l0SHViIEFQSSIsInYiOjIsInQiOltdLCJzIjpbeyJrZXkiOiJnaXRodWItY3JlYXRlLWdpc3QifV0sImMiOnt9fQ) - Allows you to add a new gist with one or more files. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-gist/create-gist.mjs))
110110
- [Create Issue Comment](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIElzc3VlIENvbW1lbnQgd2l0aCB0aGUgR2l0SHViIEFQSSIsInYiOjIsInQiOltdLCJzIjpbeyJrZXkiOiJnaXRodWItY3JlYXRlLWlzc3VlLWNvbW1lbnQifV0sImMiOnt9fQ) - Create a new comment in a issue. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-issue-comment/create-issue-comment.mjs))
111111
- [Create or update file contents](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIG9yIHVwZGF0ZSBmaWxlIGNvbnRlbnRzIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLWNyZWF0ZS1vci11cGRhdGUtZmlsZS1jb250ZW50cyJ9XSwiYyI6e319) - Create or update a file in a repository. This will replace an existing file. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-or-update-file-contents/create-or-update-file-contents.mjs))
112112
- [Create Pull Request](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIFB1bGwgUmVxdWVzdCB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1jcmVhdGUtcHVsbC1yZXF1ZXN0In1dLCJjIjp7fX0) - Creates a new pull request for a specified repository. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-pull-request/create-pull-request.mjs))
113113
- [Create Repository](https://pipedream.com/new?h=eyJuIjoiQ3JlYXRlIFJlcG9zaXRvcnkgd2l0aCB0aGUgR2l0SHViIEFQSSIsInYiOjIsInQiOltdLCJzIjpbeyJrZXkiOiJnaXRodWItY3JlYXRlLXJlcG9zaXRvcnkifV0sImMiOnt9fQ) - Creates a new repository for the authenticated user. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/create-repository/create-repository.mjs))
114-
- [Get Issue Assignees](https://pipedream.com/new?h=eyJuIjoiR2V0IElzc3VlIEFzc2lnbmVlcyB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1nZXQtaXNzdWUtYXNzaWduZWVzIn1dLCJjIjp7fX0) - Get assignees for an issue in a Github repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/get-issue-assignees/get-issue-assignees.mjs))
114+
- [Get Issue Assignees](https://pipedream.com/new?h=eyJuIjoiR2V0IElzc3VlIEFzc2lnbmVlcyB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1nZXQtaXNzdWUtYXNzaWduZWVzIn1dLCJjIjp7fX0) - Get assignees for an issue in a GitHub repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/get-issue-assignees/get-issue-assignees.mjs))
115115
- [Get Repository](https://pipedream.com/new?h=eyJuIjoiR2V0IFJlcG9zaXRvcnkgd2l0aCB0aGUgR2l0SHViIEFQSSIsInYiOjIsInQiOltdLCJzIjpbeyJrZXkiOiJnaXRodWItZ2V0LXJlcG9zaXRvcnkifV0sImMiOnt9fQ) - Get specific repository. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/get-repository/get-repository.mjs))
116116
- [Get Repository Content](https://pipedream.com/new?h=eyJuIjoiR2V0IFJlcG9zaXRvcnkgQ29udGVudCB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1nZXQtcmVwb3NpdG9yeS1jb250ZW50In1dLCJjIjp7fX0) - Get the content of a file or directory in a specific repository. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/get-repository-content/get-repository-content.mjs))
117117
- [Get Reviewers](https://pipedream.com/new?h=eyJuIjoiR2V0IFJldmlld2VycyB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1nZXQtcmV2aWV3ZXJzIn1dLCJjIjp7fX0) - Get reviewers for a PR. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/get-reviewers/get-reviewers.mjs))
118118
- [List Gists for a User](https://pipedream.com/new?h=eyJuIjoiTGlzdCBHaXN0cyBmb3IgYSBVc2VyIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLWxpc3QtZ2lzdHMtZm9yLWEtdXNlciJ9XSwiYyI6e319) - Lists public gists for the specified user. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/list-gists-for-a-user/list-gists-for-a-user.mjs))
119119
- [List Releases](https://pipedream.com/new?h=eyJuIjoiTGlzdCBSZWxlYXNlcyB3aXRoIHRoZSBHaXRIdWIgQVBJIiwidiI6MiwidCI6W10sInMiOlt7ImtleSI6ImdpdGh1Yi1saXN0LXJlbGVhc2VzIn1dLCJjIjp7fX0) - List releases for a repository. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/list-releases/list-releases.mjs))
120120
- [Update Gist](https://pipedream.com/new?h=eyJuIjoiVXBkYXRlIEdpc3Qgd2l0aCB0aGUgR2l0SHViIEFQSSIsInYiOjIsInQiOltdLCJzIjpbeyJrZXkiOiJnaXRodWItdXBkYXRlLWdpc3QifV0sImMiOnt9fQ) - Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. At least one of description or files is required. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/update-gist/update-gist.mjs))
121-
- [Update Issue](https://pipedream.com/new?h=eyJuIjoiVXBkYXRlIElzc3VlIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLXVwZGF0ZS1pc3N1ZSJ9XSwiYyI6e319) - Update a new issue in a Github repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/update-issue/update-issue.mjs))
121+
- [Update Issue](https://pipedream.com/new?h=eyJuIjoiVXBkYXRlIElzc3VlIHdpdGggdGhlIEdpdEh1YiBBUEkiLCJ2IjoyLCJ0IjpbXSwicyI6W3sia2V5IjoiZ2l0aHViLXVwZGF0ZS1pc3N1ZSJ9XSwiYyI6e319) - Update a new issue in a GitHub repo. ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/actions/update-issue/update-issue.mjs))
122122

123123
You can [create your own actions](https://pipedream.com/docs/components/quickstart/nodejs/actions/), which you can re-use across workflows. You can also [publish actions to the entire Pipedream community](https://pipedream.com/docs/components/guidelines/), making them available for anyone to use.
124124

@@ -286,12 +286,12 @@ If you'd like to report a suspected vulnerability or security issue, or have any
286286

287287
Note: Event Source [New Card in Column](https://github.com/PipedreamHQ/pipedream/blob/master/components/github/sources/new-card-in-column/new-card-in-column.mjs) only supports legacy (classic) projects.
288288

289-
Please [reach out](https://pipedream.com/support/) to the Pipedream team with any technical issues or questions about the Github integration. We're happy to help!
289+
Please [reach out](https://pipedream.com/support/) to the Pipedream team with any technical issues or questions about the GitHub integration. We're happy to help!
290290

291291
# Getting Started
292292

293-
## Github Triggers: Webhooks vs. Polling
294-
The Github triggers in Pipedream enable you to get notified immediately via a webhook if you have `admin` rights on the repo you're watching. Otherwise you can still poll for updates at a regular interval for any other repo where you might not have `admin` rights.
293+
## GitHub Triggers: Webhooks vs. Polling
294+
The GitHub triggers in Pipedream enable you to get notified immediately via a webhook if you have `admin` rights on the repo you're watching. Otherwise you can still poll for updates at a regular interval for any other repo where you might not have `admin` rights.
295295

296296
**Example: New or Updated Issue**
297297
If you are an admin on the repo, this trigger will be configured as a webhook — so any time there is a new or updated issue in the repo, an event will immediately get emitted.

components/github/actions/create-branch/create-branch.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import github from "../../github.app.mjs";
44
export default {
55
key: "github-create-branch",
66
name: "Create Branch",
7-
description: "Create a new branch in a Github repo. [See the documentation](https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference)",
8-
version: "0.0.18",
7+
description: "Create a new branch in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference)",
8+
version: "0.0.19",
99
annotations: {
1010
destructiveHint: false,
1111
openWorldHint: true,

components/github/actions/create-issue/create-issue.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import asyncProps from "../common/asyncProps.mjs";
55
export default {
66
key: "github-create-issue",
77
name: "Create Issue",
8-
description: "Create a new issue in a Gihub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#create-an-issue)",
9-
version: "0.3.5",
8+
description: "Create a new issue in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#create-an-issue)",
9+
version: "0.3.6",
1010
annotations: {
1111
destructiveHint: false,
1212
openWorldHint: true,

components/github/actions/get-commit/get-commit.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import github from "../../github.app.mjs";
33
export default {
44
key: "github-get-commit",
55
name: "Get Commit",
6-
description: "Get a commit in a Github repo. [See the documentation](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit)",
7-
version: "0.0.2",
6+
description: "Get a commit in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit)",
7+
version: "0.0.3",
88
annotations: {
99
destructiveHint: false,
1010
openWorldHint: true,

components/github/actions/get-issue-assignees/get-issue-assignees.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import github from "../../github.app.mjs";
33
export default {
44
key: "github-get-issue-assignees",
55
name: "Get Issue Assignees",
6-
description: "Get assignees for an issue in a Gihub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#get-an-issue)",
7-
version: "0.0.23",
6+
description: "Get assignees for an issue in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#get-an-issue)",
7+
version: "0.0.24",
88
annotations: {
99
destructiveHint: false,
1010
openWorldHint: true,

components/github/actions/list-commits/list-commits.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import github from "../../github.app.mjs";
33
export default {
44
key: "github-list-commits",
55
name: "List Commits",
6-
description: "List commits in a Github repo. [See the documentation](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits)",
7-
version: "0.0.2",
6+
description: "List commits in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits)",
7+
version: "0.0.3",
88
annotations: {
99
destructiveHint: false,
1010
openWorldHint: true,

components/github/actions/update-issue/update-issue.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ const {
99
export default {
1010
key: "github-update-issue",
1111
name: "Update Issue",
12-
description: "Update a new issue in a Gihub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#update-an-issue)",
13-
version: "0.2.5",
12+
description: "Update a new issue in a GitHub repo. [See the documentation](https://docs.github.com/en/rest/issues/issues#update-an-issue)",
13+
version: "0.2.6",
1414
annotations: {
1515
destructiveHint: true,
1616
openWorldHint: true,

components/github/actions/update-project-v2-item-status/update-project-v2-item-status.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export default {
44
key: "github-update-project-v2-item-status",
55
name: "Update Project (V2) Item Status",
66
description: "Update the status of an item in the selected Project (V2). [See the documentation](https://docs.github.com/en/graphql/reference/mutations#updateprojectv2itemfieldvalue)",
7-
version: "0.0.7",
7+
version: "0.0.8",
88
annotations: {
99
destructiveHint: true,
1010
openWorldHint: true,

0 commit comments

Comments
 (0)