From 3e31bc088733c5a759086240d9d84955a4ec3be1 Mon Sep 17 00:00:00 2001 From: jpomfret Date: Thu, 7 May 2020 17:19:24 +0100 Subject: [PATCH 1/2] adding usage for projects --- USAGE.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/USAGE.md b/USAGE.md index 7463adb9..98e673ca 100644 --- a/USAGE.md +++ b/USAGE.md @@ -56,6 +56,15 @@ * [Get events from a repository](#get-events-from-a-repository) * [Get events from an issue](#get-events-from-an-issue) * [Get a single event](#get-a-single-event]) + * [Projects](#Projects) + * [Get projects for a repository](#get-projects-for-a-repository) + * [Get projects for a user](#get-projects-for-a-user) + * [Create a project](#create-a-project) + * [Add a column to a project](#add-a-column-to-a-project) + * [Add a card to a column](#add-a-card-to-a-column) + * [Add an existing issue as a card to a column](#add-an-existing-issue-as-a-card-to-a-column) + * [Move a card to be after a certain card in the same column](Move-a-card-to-be-after-a-certain-card-in-the-same-column) + * [Move a card to the bottom of another column](Move-a-card-to-the-bottom-of-another-column) * [Advanced](#advanced) * [Migrating blog comments to GitHub issues](#migrating-blog-comments-to-github-issues) @@ -501,6 +510,50 @@ Get-GitHubEvent -OwnerName Microsoft -RepositoryName PowerShellForGitHub -EventI ---------- +### Projects + +#### Get projects for a repository +```powershell +Get-GitHubProject -OwnerName Microsoft -RepositoryName PowerShellForGitHub +``` + +#### Get projects for a user +```powershell +Get-GitHubProject -UserName octocat +``` + +#### Create a project +```powershell +New-GitHubProject -OwnerName jpomfret -RepositoryName PowerShellForGitHub -Name TestProject +``` + +#### Add a column to a project +```powershell +New-GitHubProjectColumn -Project 1 -Name 'To Do' +``` + +#### Add a card to a column +```powershell +New-GitHubProjectCard -Column 2 -Note 'Fix this bug' +``` + +#### Add an existing issue as a card to a column +```powershell +New-GitHubProjectCard -Column 2 -ContentId 3 -ContentType Issue +``` + +#### Move a card to be after a certain card in the same column +```powershell +Move-GitHubProjectCard -Card 4 -After 5 +``` + +#### Move a card to the bottom of another column +```powershell +Move-GitHubProjectCard -Card 4 -ColumnId 6 -Bottom +``` + +---------- + ### Advanced #### Migrating blog comments to GitHub issues From 6e09345e5da00bab46d1542873777281ec108ac4 Mon Sep 17 00:00:00 2001 From: jpomfret Date: Thu, 7 May 2020 17:48:15 +0100 Subject: [PATCH 2/2] fix couple of spelling errors --- USAGE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/USAGE.md b/USAGE.md index 98e673ca..844d1186 100644 --- a/USAGE.md +++ b/USAGE.md @@ -10,7 +10,7 @@ * [Querying Pull Requests](#querying-pull-requests) * [Querying Collaborators](#querying-collaborators) * [Querying Contributors](#querying-contributors) - * [Quering Team and Organization Membership](#querying-team-and-organization-membership) + * [Querying Team and Organization Membership](#querying-team-and-organization-membership) * [Labels](#labels) * [Getting Labels for a Repository](#getting-labels-for-a-repository) * [Getting Labels for an issue](#getting-labels-for-an-issue) @@ -280,7 +280,7 @@ Get-GitHubRepositoryContributor -OwnerName 'PowerShell' -RepositoryName 'PowerSh Sort-Object ``` -#### Quering Team and Organization Membership +#### Querying Team and Organization Membership ```powershell $organizationMembers = Get-GitHubOrganizationMembers -OrganizationName 'OrganizationName' @@ -313,7 +313,7 @@ New-GitHubLabel -OwnerName PowerShell -RepositoryName DesiredStateConfiguration #### Removing a Label From a Repository ```powershell -Remove-GitHubLabel -OwnerName PowerShell -RepositoryName desiredstateconfiguration -Name TestLabel +Remove-GitHubLabel -OwnerName PowerShell -RepositoryName DesiredStateConfiguration -Name TestLabel ``` #### Adding Labels to an Issue @@ -324,7 +324,7 @@ Add-GitHubIssueLabel -OwnerName $script:ownerName -RepositoryName $repositoryNam #### Removing a Label From an Issue ```powershell -Remove-GitHubIssueLabel -OwnerName Microsoft -RepositoryName desiredstateconfiguration -Name TestLabel -Issue 1 +Remove-GitHubIssueLabel -OwnerName Microsoft -RepositoryName DesiredStateConfiguration -Name TestLabel -Issue 1 ``` #### Updating a Label With a New Name and Color @@ -407,7 +407,7 @@ Get-GitHubCloneTraffic -OwnerName Microsoft -RepositoryName PowerShellForGitHub #### Get assignees ```powershell -Get-GitHubAsignee -OwnerName Microsoft -RepositoryName PowerShellForGitHub +Get-GitHubAssignee -OwnerName Microsoft -RepositoryName PowerShellForGitHub ``` #### Check assignee permission @@ -524,7 +524,7 @@ Get-GitHubProject -UserName octocat #### Create a project ```powershell -New-GitHubProject -OwnerName jpomfret -RepositoryName PowerShellForGitHub -Name TestProject +New-GitHubProject -OwnerName octocat -RepositoryName PowerShellForGitHub -Name TestProject ``` #### Add a column to a project