set default value of status input to false + minor readme update

README.md

@@ -64,9 +64,8 @@ See [Testing Farm onboarding guide](https://docs.testing-farm.io/general/0.1/onb
 | `create_issue_comment` | If GitHub action will create a github issue comment | false |
 | `pull_request_status_name` | GitHub pull request status name | Fedora |
 | `debug` | Print debug logs when working with testing farm | true |
-| `update_pull_request_status` | Action will update pull request status. Default: true | true |
-| `environment_settings` | Pass custom settings to the test environment. Default: {} | empty |
-| `pr_head_sha` | SHA of the latest commit in PR. Used for setting commit statuses. | $(git rev-parse HEAD) |
+| `update_pull_request_status` | Action will update pull request status. | false |
+| `environment_settings` | Pass custom settings to the test environment. | empty |
 | `create_github_summary` | Create summary of the Testing Farm as GiHub Action job. Possible options: "false", "true", "key=value" | true |
 | `timeout` | Timeout for the Testing Farm job in minutes. | 480 |
 

action.yml

@@ -14,16 +14,16 @@ inputs:
     description: 'A testing farm API key'
     required: true
   git_url:
-    description: 'An url to the GIT repository'
+    description: 'An url to the GIT repository with TMT plans'
     required: true
   git_ref:
-    description: 'A tmt tests branch which will be used for tests'
+    description: 'A TMT tests branch which will be used for tests'
     required: false
     default: 'master'
   github_token:
-    description: GitHub TOKEN or PAT
+    description: 'GitHub TOKEN or PAT'
     required: false
-    default: ${{ github.token }}
+    default: '${{ github.token }}'
   tmt_plan_regex:
     required: false
     description: 'A tmt plan regex which will be used for selecting plans. By default all plans are selected.'
@@ -50,7 +50,7 @@ inputs:
   update_pull_request_status:
     description: 'Action will update pull request status. Default: true'
     required: false
-    default: 'true'
+    default: 'false'
   create_github_summary:
     description: 'Action will create github summary. Possible options: "false", "true", "key=value"'
     required: false
@@ -79,10 +79,6 @@ inputs:
     description: 'Pass specific settings, like post-install-script, to the testing environment.'
     required: false
     default: '{}'
-  pr_head_sha:
-    description: 'HEAD SHA of a Pull Request. Used for posting statuses to the PR. The value is obtained from `git rev-parse HEAD` if this input is not set.'
-    required: false
-    default: ''
   timeout:
     description: 'Action is waiting for testing farm to finish or until timeout is reached. Value is in minutes.'
     required: false

src/action.ts

@@ -37,10 +37,7 @@ async function action(pr: PullRequest): Promise<void> {
   const api = new TestingFarmAPI(tfInstance);
 
   // Get commit SHA value
-  let sha = getInput('pr_head_sha');
-  if (sha === '') {
-    sha = pr.sha;
-  }
+  const sha = pr.sha;
   debug(`SHA: '${sha}'`);
 
   // Set artifacts url

tests/action.test.ts

@@ -26,8 +26,8 @@ function setDefaultInputs() {
   vi.stubEnv('INPUT_VARIABLES', '');
   // secrets - Secret environment variables for test env, separated by ;
   vi.stubEnv('INPUT_SECRETS', '');
-  // update_pull_request_status - Action will update pull request status. Default: true
-  vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
+  // update_pull_request_status - Action will update pull request status. Default: false
+  vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'false');
   // create_github_summary - Action will create github summary. Possible options: "false", "true", "key=value"
   vi.stubEnv('INPUT_CREATE_GITHUB_SUMMARY', 'true');
   // arch - Define an architecture for testing environment. Default: x86_64
@@ -218,17 +218,13 @@ describe('Integration tests', () => {
     );
 
     // First call to request PR details, next two calls for setting the status
-    expect(mocks.request).toHaveBeenCalledTimes(3);
+    expect(mocks.request).toHaveBeenCalledTimes(1);
     expect(mocks.request).toHaveBeenLastCalledWith(
-      'POST /repos/{owner}/{repo}/statuses/{sha}',
+      'GET /repos/{owner}/{repo}/pulls/{pull_number}',
       {
-        context: 'Testing Farm - Fedora',
-        description: 'Build finished - \\o/',
         owner: 'sclorg',
+        pull_number: 1,
         repo: 'testing-farm-as-github-action',
-        sha: 'd20d0c37d634a5303fa1e02edc9ea281897ba01a',
-        state: 'success',
-        target_url: 'https://artifacts.dev.testing-farm.io/1',
       }
     );
 
@@ -253,6 +249,7 @@ describe('Integration tests', () => {
     );
     // tmt_plan_regex - A tmt plan regex which will be used for selecting plans. By default all plans are selected
     vi.stubEnv('INPUT_TMT_PLAN_REGEX', 'fedora');
+    vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
 
     // Mock Testing Farm API
     vi.mocked(mocks.newRequest).mockImplementation(
@@ -332,6 +329,7 @@ describe('Integration tests', () => {
     );
     // tmt_plan_regex - A tmt plan regex which will be used for selecting plans. By default all plans are selected
     vi.stubEnv('INPUT_TMT_PLAN_REGEX', 'fedora');
+    vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
 
     // Mock Testing Farm API
     vi.mocked(mocks.newRequest).mockImplementation(
@@ -411,6 +409,7 @@ describe('Integration tests', () => {
     );
     // tmt_plan_regex - A tmt plan regex which will be used for selecting plans. By default all plans are selected
     vi.stubEnv('INPUT_TMT_PLAN_REGEX', 'fedora');
+    vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
 
     // Override default inputs
     // Action is waiting for testing farm to finish or until timeout is reached
@@ -477,6 +476,7 @@ describe('Integration tests', () => {
     );
     // tmt_plan_regex - A tmt plan regex which will be used for selecting plans. By default all plans are selected
     vi.stubEnv('INPUT_TMT_PLAN_REGEX', 'fedora');
+    vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
 
     // Override default inputs
     // tf_scope - Defines the scope of Testing Farm. Possible options are public and private
@@ -551,6 +551,7 @@ describe('Integration tests', () => {
     );
     // tmt_plan_regex - A tmt plan regex which will be used for selecting plans. By default all plans are selected
     vi.stubEnv('INPUT_TMT_PLAN_REGEX', 'fedora');
+    vi.stubEnv('INPUT_UPDATE_PULL_REQUEST_STATUS', 'true');
 
     // Override default inputs
     // create_issue_comment - It creates a github issue Comment