Skip to content

Commit

Permalink
add documentation on new people.json fields and sheriff config
Browse files Browse the repository at this point in the history
Signed-off-by: Jeffrey Sica <[email protected]>
  • Loading branch information
jeefy committed Dec 15, 2022
1 parent 714b03f commit b828925
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 20 deletions.
21 changes: 1 addition & 20 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,4 @@ jobs:
uses: docker://orrosenblatt/validate-json-action:latest
env:
INPUT_SCHEMA: /schema.json
INPUT_JSONS: /people.json
verify-config-yaml:
runs-on: ubuntu-latest
env:
SHERIFF_IMPORTANT_BRANCH: main
SHERIFF_PLUGINS: cncfSlack
PERMISSIONS_FILE_ORG: cncf
PERMISSIONS_FILE_REPO: people
PR_FILE_ORG: ${{ github.actor }}
PR_FILE_REPO: ${GITHUB_REPOSITORY#*/}
PR_FILE_REF: ${{ github.ref_name }}
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
SHERIFF_GITHUB_APP_CREDS: ${{ secrets.SHERIFF_GITHUB_APP_CREDS }}
SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
GSUITE_CREDENTIALS: ${{ secrets.GSUITE_CREDENTIALS }}
container:
image: us.gcr.io/cncf-slack-infra/sheriff/sheriff:cncf-slack-plugin
steps:
- name: Do a dry-run with Sheriff to validate configs and output changes
run: node lib/permissions/run.js
INPUT_JSONS: /people.json
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"githubPullRequests.ignoredPullRequestBranches": [
"main"
]
}
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ The [people.json file](https://github.com/cncf/people/blob/main/people.json) lis
"languages":[Array of languages spoken],
"projects":[Array of CNCF projects of expertise],
"category":[Array of categories the person belongs to],
"email": "person!example.com",
"slack_id": "U123ABC456",
"image":"Image filename from the /images/ directory"
}
```
Expand All @@ -49,10 +51,23 @@ And here is an example entry:
"languages":["Spanish","English"],
"projects":["prometheus","kubernetes","envoy"],
"category":["Ambassadors"],
"email": "johnny!example.com",
"slack_id": "U123ABC456",
"image":"jappleseed.jpg"
}
```

## Images

Upload your headshot image to the `/images/` directory with a filename made up of your name. Images should be at least 500x500px, 72dpi, and should be in JPG format with file size less than 100kB.

## Team Management

Also within this repo is a YAML file used by our [automation tooling](https://github.com/electronjs/sheriff) to help us manage access to resources for teams. This tooling takes advantage of data in [people.json](people.json) such as the `email` and `slack_id` fields. This will allow us to add maintainers to different properties only using their GitHub handle.

* To find your Slack ID for the CNCF slack, please follow this [handy guide](https://moshfeu.medium.com/how-to-find-my-member-id-in-slack-workspace-d4bba942e38c)

* When adding your email, please follow the same format used within [devstats](https://github.com/cncf/devstats):
```
email!address.xyz
```

0 comments on commit b828925

Please sign in to comment.