Skip to content

Commit

Permalink
Preparing release v1.0.0 (#2)
Browse files Browse the repository at this point in the history 
Preparing initial release
  • Loading branch information
@Matticusau
Matticusau authored Feb 8, 2021
1 parent 21b68c1 commit 65da96d
Show file tree
Hide file tree
Showing 10 changed files with 1,305 additions and 95 deletions.
10 changes: 7 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ Set the following inputs in the workflow file
### `autolabel-config`

Provide the project column configuration for the auto labeling based on column name pattern matches. JSON object as string, example format [{"column":"in-progress"; "add-labels":["in-progress"]; "remove-labels":["triage"]}].
Provide the project column configuration for the auto labeling based on column name pattern matches. JSON object as string, example format [{"column":"In progress", "add_labels":["in-progress"], "remove_labels":["triage"]}].

### `projectfilter-config`

Provide the project patterns which will include/exclude projects. JSON object as string, example format {"include":["projectid"], "exclude":[]}.

## Outputs

Expand All @@ -57,7 +61,7 @@ jobs:
uses: Matticusau/[email protected]
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
autolabel-config: '[{"column":"in-progress"; "add-labels":["in-progress"]; "remove-labels":["triage"]}]'
autolabel-config: '[{"column":"In progress", "add_labels":["in-progress"], "remove_labels":["triage"]}]'
```
> Note: The `uses` syntax includes tag/branch specification. For the latest release see [tags](https://github.com/Matticusau/projectcard-autolabel/tags).
Expand All @@ -83,7 +87,7 @@ The action can be customized using the additional inputs on the workflow yaml fi
```yml
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
autolabel-config: '[{"column":"in-progress"; "add-labels":["in-progress"]; "remove-labels":["triage"]}]'
autolabel-config: '[{"column":"In progress", "add_labels":["in-progress"], "remove_labels":["triage"]}]'
```

## Troubleshooting
Expand Down
5 changes: 4 additions & 1 deletion action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ inputs:
autolabel-config:
description: 'Provide the project column configuration for the auto labeling based on column name pattern matches. JSON object as string.'
required: true
projectfilter-config:
description: 'Provide the project filter pattern configuration for the inclusions and exclusion of projects. JSON object as string.'
required: true
runs:
using: 'node12'
main: 'lib/index.js'
branding:
icon: git-merge
icon: sliders
color: green
176 changes: 176 additions & 0 deletions docs/ProjectCards.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,179 @@ This was investigated in [Issue #35](https://github.com/Matticusau/pr-helper/iss
}
]
```


Sample Payload

```json
{
"payload": {
"action": "moved",
"changes": {
"column_id": {
"from": 12821424
}
},
"project_card": {
"after_id": null,
"archived": false,
"column_id": 12821425,
"column_url": "https://api.github.com/projects/columns/12821425",
"content_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/issues/23",
"created_at": "2021-02-07T11:50:32Z",
"creator": {
"avatar_url": "https://avatars.githubusercontent.com/u/11083642?v=4",
"events_url": "https://api.github.com/users/Matticusau/events{/privacy}",
"followers_url": "https://api.github.com/users/Matticusau/followers",
"following_url": "https://api.github.com/users/Matticusau/following{/other_user}",
"gists_url": "https://api.github.com/users/Matticusau/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/Matticusau",
"id": 11083642,
"login": "Matticusau",
"node_id": "MDQ6VXNlcjExMDgzNjQy",
"organizations_url": "https://api.github.com/users/Matticusau/orgs",
"received_events_url": "https://api.github.com/users/Matticusau/received_events",
"repos_url": "https://api.github.com/users/Matticusau/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/Matticusau/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/Matticusau/subscriptions",
"type": "User",
"url": "https://api.github.com/users/Matticusau"
},
"id": 54410237,
"node_id": "MDExOlByb2plY3RDYXJkNTQ0MTAyMzc=",
"note": null,
"project_url": "https://api.github.com/projects/11613902",
"updated_at": "2021-02-07T12:13:09Z",
"url": "https://api.github.com/projects/columns/cards/54410237"
},
"repository": {
"archive_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/assignees{/user}",
"blobs_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/branches{/branch}",
"clone_url": "https://github.com/Matticusau/pr-helper-demo.git",
"collaborators_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/comments{/number}",
"commits_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/commits{/sha}",
"compare_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/contents/{+path}",
"contributors_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/contributors",
"created_at": "2020-06-18T21:32:34Z",
"default_branch": "main",
"deployments_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/deployments",
"description": "Repository for demo and testing of https://github.com/Matticusau/pr-helper. Experimentation of features welcomed.",
"disabled": false,
"downloads_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/downloads",
"events_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/events",
"fork": false,
"forks": 0,
"forks_count": 0,
"forks_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/forks",
"full_name": "Matticusau/pr-helper-demo",
"git_commits_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/git/tags{/sha}",
"git_url": "git://github.com/Matticusau/pr-helper-demo.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": "",
"hooks_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/hooks",
"html_url": "https://github.com/Matticusau/pr-helper-demo",
"id": 273344153,
"issue_comment_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/issues/events{/number}",
"issues_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/issues{/number}",
"keys_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/keys{/key_id}",
"labels_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/labels{/name}",
"language": null,
"languages_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/languages",
"license": {
"key": "mit",
"name": "MIT License",
"node_id": "MDc6TGljZW5zZTEz",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"merges_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/merges",
"milestones_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/milestones{/number}",
"mirror_url": null,
"name": "pr-helper-demo",
"node_id": "MDEwOlJlcG9zaXRvcnkyNzMzNDQxNTM=",
"notifications_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/notifications{?since,all,participating}",
"open_issues": 2,
"open_issues_count": 2,
"owner": {
"avatar_url": "https://avatars.githubusercontent.com/u/11083642?v=4",
"events_url": "https://api.github.com/users/Matticusau/events{/privacy}",
"followers_url": "https://api.github.com/users/Matticusau/followers",
"following_url": "https://api.github.com/users/Matticusau/following{/other_user}",
"gists_url": "https://api.github.com/users/Matticusau/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/Matticusau",
"id": 11083642,
"login": "Matticusau",
"node_id": "MDQ6VXNlcjExMDgzNjQy",
"organizations_url": "https://api.github.com/users/Matticusau/orgs",
"received_events_url": "https://api.github.com/users/Matticusau/received_events",
"repos_url": "https://api.github.com/users/Matticusau/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/Matticusau/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/Matticusau/subscriptions",
"type": "User",
"url": "https://api.github.com/users/Matticusau"
},
"private": true,
"pulls_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/pulls{/number}",
"pushed_at": "2021-02-07T12:04:23Z",
"releases_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/releases{/id}",
"size": 51,
"ssh_url": "[email protected]:Matticusau/pr-helper-demo.git",
"stargazers_count": 0,
"stargazers_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/stargazers",
"statuses_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/subscribers",
"subscription_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/subscription",
"svn_url": "https://github.com/Matticusau/pr-helper-demo",
"tags_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/tags",
"teams_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/teams",
"trees_url": "https://api.github.com/repos/Matticusau/pr-helper-demo/git/trees{/sha}",
"updated_at": "2021-02-07T12:04:25Z",
"url": "https://api.github.com/repos/Matticusau/pr-helper-demo",
"watchers": 0,
"watchers_count": 0
},
"sender": {
"avatar_url": "https://avatars.githubusercontent.com/u/11083642?v=4",
"events_url": "https://api.github.com/users/Matticusau/events{/privacy}",
"followers_url": "https://api.github.com/users/Matticusau/followers",
"following_url": "https://api.github.com/users/Matticusau/following{/other_user}",
"gists_url": "https://api.github.com/users/Matticusau/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/Matticusau",
"id": 11083642,
"login": "Matticusau",
"node_id": "MDQ6VXNlcjExMDgzNjQy",
"organizations_url": "https://api.github.com/users/Matticusau/orgs",
"received_events_url": "https://api.github.com/users/Matticusau/received_events",
"repos_url": "https://api.github.com/users/Matticusau/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/Matticusau/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/Matticusau/subscriptions",
"type": "User",
"url": "https://api.github.com/users/Matticusau"
}
},
"eventName": "project_card",
"sha": "0afe8d9b5854f2bf5e80ae60a8981c6785cb58e8",
"ref": "refs/heads/main",
"workflow": "ProjectCard Auto Labels",
"action": "Matticusauprojectcard-autolabel",
"actor": "Matticusau"
}
```
Loading

0 comments on commit 65da96d

Please sign in to comment.