Skip to content

Commit

Permalink
Update READMEs and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
kenodegard committed Apr 4, 2023
1 parent ec9f0b4 commit a3dded4
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 26 deletions.
41 changes: 25 additions & 16 deletions check-cla/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,52 @@
# Check CLA (Contributor License Agreement)

This is a custom GitHub action to be used in the conda GitHub organization
for checking the conda contributor license agreement.
A custom GitHub action to be used in the conda GitHub organization for checking the
conda contributor license agreement.

## GitHub Action Usage

In your GitHub repository include the action in your workflows:

```yaml
name: Contributor license agreement (CLA)
name: Check CLA

on:
issue_comment:
types:
- created
pull_request_target:
types:
- reopened
- opened
- synchronize

jobs:
check:
if: >-
!github.event.repository.fork
&& (
(
github.event.comment.body == '@conda-bot check'
&& github.event.issue.pull_request
|| github.event_name == 'pull_request_target'
)
runs-on: ubuntu-latest
steps:
- name: Check CLA
uses: conda/actions/check-cla
- uses: conda/actions/check-cla
with:
# [required]
# label to add when actor has signed the CLA
label: cla-signed
# A token with ability to comment, label, and modify the commit status
# (`pull_request: write` and `statuses: write`)
# (default: secrets.GITHUB_TOKEN)
token:
# [required]
# Label to apply to contributor's PR once CLA is singed
label:

# Upstream repository in which to create PR
# (default: conda/infrastructure)
cla_repo:
# Path to the CLA signees file within the provided `cla_repo`
# (default: .clabot)
cla_path:

# Fork of cla_repo in which to create branch
# (default: conda-bot/infrastructure)
cla_fork:
# [required]
# the GitHub Personal Access Token to comment and label with
token: ${{ secrets.CLA_ACTION_TOKEN }}
# Token for opening singee PR in the provided `cla_repo`
cla_token:
```
10 changes: 5 additions & 5 deletions check-cla/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CLA check
description: Reacts to new PRs and check if the contributor has previously signed the conda contributor license agreement (CLA).
inputs:
token:
description: The GitHub token (`statuses: write` and `pull_request: write`) used to create an authenticated client
description: 'A token with ability to comment, label, and modify the commit status (`pull_request: write` and `statuses: write`)'
default: ${{ github.token }}
required: true
label:
Expand All @@ -12,15 +12,15 @@ inputs:
cla_repo:
description: Upstream repository in which to create PR
default: conda/infrastructure
cla_path:
description: Path to the CLA signees file within the provided `cla_repo`
default: .clabot
cla_fork:
description: Fork of cla_repo in which to create branch
default: conda-bot/infrastructure
cla_token:
description: Token for opening singee PR in the provided `cla_repo`
description: Token for opening singee PR in `cla_fork`
required: true
cla_path:
description: Path to the CLA signees file within the provided `cla_repo`
default: .clabot

runs:
using: composite
Expand Down
9 changes: 6 additions & 3 deletions set-commit-status/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ status.
In your GitHub repository include the action in your workflows:

```yaml
name: Set commit status
name: Set Commit Status

on: pull_request_target

Expand All @@ -22,15 +22,18 @@ jobs:
- uses: conda/actions/set-commit-status
with:
# [required]
# The GitHub token (`statuses: write`) used to create an authenticated client
# A token with the ability to modify the commit status
# (`statuses: write`)
# (default: secrets.GITHUB_TOKEN)
token:

# [required]
# The name of the commit status
context:
# [required]
# The commit status to set, either success, error, failure, or pending
# The commit status to set; either success, error, failure, or pending
state:

# A short text explaining the commit status
# (default: '')
description:
Expand Down
4 changes: 2 additions & 2 deletions set-commit-status/action.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: Set Commit Status
description: Modifies the commit status of the most recent commit.
inputs:
token:
description: "The GitHub token (`statuses: write`) used to create an authenticated client"
description: 'The GitHub token (`statuses: write`) used to create an authenticated client'
default: ${{ github.token }}
required: true
context:
Expand Down Expand Up @@ -52,4 +53,3 @@ runs:
} catch (error) {
throw new Error(`error while setting commit status: ${(error as Error).message}`);
}

0 comments on commit a3dded4

Please sign in to comment.