Skip to content

Commit

Permalink
docs: add note about GitHub token permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
@alikhajeh1
alikhajeh1 committed Dec 15, 2021
1 parent 9a2bca1 commit 70423f8
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions comment/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ The action supports the following inputs:

- `target-type`: Optional. Which objects should be commented on, either `pull-request` or `commit`.

- `tag`: Optional. Customize the comment tag. This is added to the comment as a markdown comment to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.
- `tag`: Optional. Customize the comment tag. This is added to the comment as a markdown comment (hidden) to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.

- `github-token`: Optional, default to `${{ github.token }}`. This is the default GitHub token available to actions and is used to post comments.
- `github-token`: Optional, default to `${{ github.token }}`. This is the default GitHub token available to actions and is used to post comments. The default [token permissions](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions) work fine; `pull-requests: write` is required if you need to customize these.

## Outputs

Expand Down
4 changes: 2 additions & 2 deletions comment/action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ inputs:
description: Which objects should be commented on, either `pull-request` or `commit`.
required: false
tag:
description: 'Customize the comment tag. This is added to the comment as a markdown comment to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.'
description: 'Customize the comment tag. This is added to the comment as a markdown comment (hidden) to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.'
required: false
github-token:
description: 'Default to {{ github.token }}. This is the default GitHub token available to actions and is used to post comments.'
description: 'Default to {{ github.token }}. This is the default GitHub token available to actions and is used to post comments. The default token permissions (https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions) work fine; `pull-requests: write` is required if you need to customize these.'
default: '${{ github.token }}'
required: false
outputs:
Expand Down
4 changes: 2 additions & 2 deletions get-comment/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ The action supports the following inputs:
- `target-type`: Optional. The target-type set when the comment was posted (if any), either `pull_request` or `commit`.

- `tag`: Optional. Customize the comment tag. This is added to the comment as a markdown comment to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.
- `tag`: Optional. Customize the comment tag. This is added to the comment as a markdown comment (hidden) to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.

- `github-token`: Optional, default to `${{ github.token }}`. This is the default GitHub token available to actions and is used to get comments.
- `github-token`: Optional, default to `${{ github.token }}`. This is the default GitHub token available to actions and is used to get comments. The default [token permissions](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions) work fine; `pull-requests: read` is required if you need to customize these.

## Outputs

Expand Down
4 changes: 2 additions & 2 deletions get-comment/action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ inputs:
description: The target-type set when the comment was posted (if any), either `pull-request` or `commit`.
required: false
tag:
description: 'Customize the comment tag. This is added to the comment as a markdown comment to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.'
description: 'Customize the comment tag. This is added to the comment as a markdown comment (hidden) to detect the previously posted comments. This is useful if you have multiple workflows that post comments to the same pull request or commit.'
required: false
github-token:
description: 'Default to {{ github.token }}. This is the default GitHub token available to actions and is used to get comments.'
description: 'Default to {{ github.token }}. This is the default GitHub token available to actions and is used to get comments. The default token permissions (https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions) work fine; `pull-requests: read` is required if you need to customize these.'
default: '${{ github.token }}'
required: false
outputs:
Expand Down

1 comment on commit 70423f8

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💰 Infracost estimate: monthly cost will increase by $110,130 📈

Project Previous New Diff
infracost/infracost/examples/terraform/plan.json $0 $55,065 +$55,065
infracost/infracost/examples/terraform/plan.json $0 $55,065 +$55,065
All projects $0 $110,130 +$110,130
Infracost output 
Project: infracost/infracost/examples/terraform/plan.json

+ aws_instance.web_app
  +$55,065

    + Instance usage (Linux/UNIX, on-demand, m5.4xlarge)
      +$41,570

    + root_block_device
    
        + Storage (general purpose SSD, gp2)
          +$371

    + ebs_block_device[0]
    
        + Storage (provisioned IOPS SSD, io1)
          +$9,268
    
        + Provisioned IOPS
          +$3,856

+ aws_lambda_function.hello_world
  Monthly cost depends on usage

    + Requests
      Monthly cost depends on usage
        +$14.83 per 1M requests

    + Duration
      Monthly cost depends on usage
        +$0.0012357988 per GB-seconds

Monthly cost change for infracost/infracost/examples/terraform/plan.json
Amount:  +$55,065 ($0.00 → $55,065)

──────────────────────────────────
Project: infracost/infracost/examples/terraform/plan.json

+ aws_instance.web_app
  +$55,065

    + Instance usage (Linux/UNIX, on-demand, m5.4xlarge)
      +$41,570

    + root_block_device
    
        + Storage (general purpose SSD, gp2)
          +$371

    + ebs_block_device[0]
    
        + Storage (provisioned IOPS SSD, io1)
          +$9,268
    
        + Provisioned IOPS
          +$3,856

+ aws_lambda_function.hello_world
  Monthly cost depends on usage

    + Requests
      Monthly cost depends on usage
        +$14.83 per 1M requests

    + Duration
      Monthly cost depends on usage
        +$0.0012357988 per GB-seconds

Monthly cost change for infracost/infracost/examples/terraform/plan.json
Amount:  +$55,065 ($0.00 → $55,065)

──────────────────────────────────
Key: ~ changed, + added, - removed

4 cloud resources were detected:
∙ 4 were estimated, 4 include usage-based costs, see https://infracost.io/usage-file
Is this comment useful? Yes, No

Please sign in to comment.