From af8340d5879c76db7413b9355d9f94d07b1a24f1 Mon Sep 17 00:00:00 2001 From: matarpeles <132199091+matarpeles@users.noreply.github.com> Date: Sat, 14 Dec 2024 18:31:13 +0200 Subject: [PATCH 1/2] README improvement to GitHub issues sync params --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ad3e0d..8356925 100644 --- a/README.md +++ b/README.md @@ -233,8 +233,9 @@ Generated Scorecard issue for the bronze level: | `blueprint` | Blueprint identifier | true | | | `scorecard` | Scorecard identifier | true | | | `opeation_kind` | What operation should the sender do, leave at - `issue_handler` | true | | +| `target_kind` | leave at - `github` | true | | | `filter_rule` | The [rule filter](https://docs.getport.io/search-and-query/#rules) to apply on the data queried from Port | false | | -| `github_api_url` | Github API URL. We recommend setting this to Github's `github.api_url` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values) URL | true | | +| `github_api_url` | Github API URL. We recommend setting this to Github's `github.api_url` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values) URL. Using GitHub Cloud, you should use - `https://api.github.com` | true | | | `github_repository` | The Github Repository. We recommend setting this to Github's `github.repository` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values) | true | | | `github_token` | The Github's Token used for create/get/update operations on issues. We recommend setting this to Github's `github.token` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values), and granting it default `issues: write` [permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) | true | | From c606da93cb4e774977e0db85e6411656002413af Mon Sep 17 00:00:00 2001 From: matarpeles <132199091+matarpeles@users.noreply.github.com> Date: Sat, 14 Dec 2024 18:33:12 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8356925..6970a18 100644 --- a/README.md +++ b/README.md @@ -236,7 +236,7 @@ Generated Scorecard issue for the bronze level: | `target_kind` | leave at - `github` | true | | | `filter_rule` | The [rule filter](https://docs.getport.io/search-and-query/#rules) to apply on the data queried from Port | false | | | `github_api_url` | Github API URL. We recommend setting this to Github's `github.api_url` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values) URL. Using GitHub Cloud, you should use - `https://api.github.com` | true | | -| `github_repository` | The Github Repository. We recommend setting this to Github's `github.repository` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values) | true | | +| `github_repository` | The Github Repository. We recommend setting this to Github's `github.repository` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values). If set manually, should be in the format `org_name/repo_name`, for example `port-labs/port-sender` | true | | | `github_token` | The Github's Token used for create/get/update operations on issues. We recommend setting this to Github's `github.token` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values), and granting it default `issues: write` [permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) | true | | This example will create a Github issue for every service in every level that are not completed in the `productionReadiness` scorecard for the Backend Team.