GitHub app actions improvements #14058
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| export default { | ||
| assignees: { | ||
| label: "Assignees", | ||
| description: "One or more Users to assign to this issue", | ||
| type: "string[]", | ||
| optional: true, | ||
| options: async () => { | ||
| const collaborators = await this.github.getRepositoryCollaborators({ | ||
| repoFullname: this.repoFullname, | ||
| }); | ||
|
|
||
| return collaborators.map(({ login }) => login); | ||
| }, | ||
| }, | ||
| labels: { | ||
| label: "Labels", | ||
| description: "The label(s) to add to the issue", | ||
| type: "string[]", | ||
| optional: true, | ||
| options: async () => { | ||
| const labels = await this.github.getRepositoryLabels({ | ||
| repoFullname: this.repoFullname, | ||
| }); | ||
|
|
||
| return labels.map(({ name }) => name); | ||
| }, | ||
| }, | ||
| milestoneNumber: { | ||
| type: "integer", | ||
| label: "Milestone Number", | ||
| description: "The number of a milestone to associate the issue with", | ||
| optional: true, | ||
| options: async () => { | ||
| const items = await this.github.getRepositoryMilestones({ | ||
| repoFullname: this.repoFullname, | ||
| }); | ||
|
|
||
| return items.map((item) => ({ | ||
| label: item.title, | ||
| value: +item.number, | ||
| })); | ||
| }, | ||
| }, | ||
| pullNumber: { | ||
| type: "integer", | ||
| label: "Pull Request Number", | ||
| description: "The pull request to get reviewers for", | ||
| options: async ({ page }) => { | ||
| const prs = await this.github.getRepositoryPullRequests({ | ||
| page: page + 1, | ||
| repoFullname: this.repoFullname, | ||
| }); | ||
|
|
||
| return prs.map((pr) => ({ | ||
| label: pr.title, | ||
| value: +pr.number, | ||
| })); | ||
| }, | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,9 @@ import github from "../../github.app.mjs"; | |
|
|
||
| export default { | ||
| key: "github-create-or-update-file-contents", | ||
| name: "Create or Update File Contents", | ||
| description: "Create or update a file in a repository. [See the documentation](https://docs.github.com/en/rest/repos/contents#create-or-update-file-contents)", | ||
| version: "0.1.0", | ||
| type: "action", | ||
| props: { | ||
| github, | ||
|
|
@@ -32,21 +32,27 @@ export default { | |
| default: "Pipedream - {{steps.trigger.context.workflow_name}} ({{steps.trigger.context.workflow_id}})", | ||
| }, | ||
| branch: { | ||
| propDefinition: [ | ||
| github, | ||
| "branch", | ||
| (c) => ({ | ||
| repoFullname: c.repoFullname, | ||
| }), | ||
| ], | ||
| description: | ||
| "The branch to use. Defaults to the repository's default branch (usually `main` or `master`)", | ||
| optional: true, | ||
| }, | ||
| }, | ||
| async run({ $ }) { | ||
| const { | ||
| github, branch, ...data | ||
| } = this; | ||
| const response = await github.createOrUpdateFileContent({ | ||
| data: { | ||
| ...data, | ||
| branch: branch?.split?.("/")[0], | ||
| }, | ||
| }); | ||
|
|
||
| $.export("$summary", `Successfully set contents of ${this.path}${this.branch | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,11 @@ | ||
| import { ConfigurationError } from "@pipedream/platform"; | ||
| import github from "../../github.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "github-create-pull-request", | ||
| name: "Create Pull Request", | ||
| description: "Creates a new pull request for a specified repository. [See the documentation](https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request)", | ||
| version: "0.1.0", | ||
| type: "action", | ||
| props: { | ||
| github, | ||
|
|
@@ -18,20 +14,8 @@ export default { | |
| github, | ||
| "repoFullname", | ||
| ], | ||
| label: "Base Repository", | ||
| description: "The base repository, where the pull request will be created.", | ||
| }, | ||
| base: { | ||
| propDefinition: [ | ||
|
|
@@ -42,58 +26,48 @@ export default { | |
| }), | ||
| ], | ||
| label: "Base Branch", | ||
| description: "The base branch, where the changes will be received.", | ||
| }, | ||
| headRepo: { | ||
| propDefinition: [ | ||
| github, | ||
| "repoFullname", | ||
| ], | ||
| label: "Head Repository", | ||
| description: "The head repository, where the changes originate from. This can, but does not have to, be the same repository.", | ||
| }, | ||
| head: { | ||
| propDefinition: [ | ||
| github, | ||
| "branch", | ||
| (c) => ({ | ||
| repoFullname: c.headRepo, | ||
| }), | ||
| ], | ||
| label: "Head Branch", | ||
| description: "The head branch, where the changes originate from", | ||
| }, | ||
| body: { | ||
| label: "Body", | ||
| description: "The text description of the pull request.", | ||
| type: "string", | ||
| optional: true, | ||
| }, | ||
| maintainerCanModify: { | ||
| label: "Maintainers Can Modify", | ||
| description: "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", | ||
| type: "boolean", | ||
| optional: true, | ||
| }, | ||
| draft: { | ||
| label: "Is Draft", | ||
| description: "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", | ||
| type: "boolean", | ||
| optional: true, | ||
| }, | ||
| title: { | ||
| label: "Title", | ||
| description: "The title of the pull request.", | ||
| type: "string", | ||
| optional: true, | ||
| }, | ||
|
|
@@ -106,21 +80,15 @@ export default { | |
| }), | ||
| ], | ||
| label: "Issue", | ||
| description: "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request.", | ||
| min: 1, | ||
| optional: true, | ||
| }, | ||
| }, | ||
| async run({ $ }) { | ||
|
|
||
| if (!this.issue && !this.title) { | ||
| throw new ConfigurationError("Title is required if Issue is unspecified. You can either specify a new pull request with Title or convert an existing issue to a pull request with Issue."); | ||
| } | ||
|
|
||
| if (this.issue && this.title) { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider refactoring common patterns in 'assignees' and 'labels' properties
The 'labels' property is structurally similar to the 'assignees' property, with the main difference being the API call and the mapped property. This similarity suggests an opportunity for refactoring to reduce code duplication.
Consider creating a higher-order function to generate these property objects. This could improve maintainability and reduce the chance of inconsistencies. Here's a potential refactor:
This refactoring would also make it easier to add new properties with similar structures in the future.