Skip to content

Commit

Permalink
chore: introduce Contributors file (#26587)
Browse files Browse the repository at this point in the history
This GitHub Action updates a CONTRIBUTORS file with the top contributors from the project, pulling contents from the GitHub API.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
evgenyka committed Aug 23, 2023
1 parent 6d1dc5b commit 9b93635
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,8 @@ Owner: Core CDK team

[repo-metrics.yml](repo-metrics.yml): GitHub action that runs monthly to report on metrics for issues and PRs created last month.
Owner: Core CDK team

### Contributors File

[update-contributors.yml](update-contributors.yml): GitHub action that runs monthly to create a pull request for updating a CONTRIBUTORS file with the top contributors.
Owner: Core CDK team
31 changes: 31 additions & 0 deletions .github/workflows/update-contributors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

name: Update CONTRIBUTORS file
on:
schedule:
- cron: "0 0 1 * *"
workflow_dispatch:
jobs:
main:
# this workflow will always fail in forks; bail if this isn't running in the upstream
if: github.repository == 'aws/aws-cdk'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: minicli/action-contributors@v3.3
name: "Update a projects CONTRIBUTORS file"
env:
CONTRIB_REPOSITORY: 'aws/aws-cdk'
CONTRIB_OUTPUT_FILE: 'CONTRIBUTORS.md'
- name: Create a PR
uses: peter-evans/create-pull-request@v5
with:
# Git commit details
branch: automation/update-contributors
author: aws-cdk-automation <aws-cdk-automation@users.noreply.github.com>
commit-message: chore: update Contributors File
# Pull Request details
title: 'chore: update Contributors File'
labels: auto-approve
# Github prevents further Github actions to be run if the default Github token is used.
# Instead use a privileged token here, so further GH actions can be triggered on this PR.
token: ${{ secrets.PROJEN_GITHUB_TOKEN }}

0 comments on commit 9b93635

Please sign in to comment.