https://github.com/webdriverio/expense-action
GitHub Action that enables WebdriverIO's expense workflow.
https://github.com/webdriverio/expense-action
Last synced: 2 months ago
JSON representation
GitHub Action that enables WebdriverIO's expense workflow.
- Host: GitHub
- URL: https://github.com/webdriverio/expense-action
- Owner: webdriverio
- License: mit
- Created: 2024-02-13T04:45:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T06:29:49.000Z (about 2 years ago)
- Last Synced: 2024-04-14T07:11:15.574Z (about 2 years ago)
- Language: TypeScript
- Homepage: https://github.com/webdriverio/webdriverio/blob/main/GOVERNANCE.md#sponsoring-and-donations
- Size: 15.9 MB
- Stars: 1
- Watchers: 11
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# WebdriverIO Expense Action
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
---
> A GitHub Action that enables WebdriverIO TSC members to grant expense requests
> for contributed PRs to the project.
This GitHub Action enables the allocation of funds for contributions received by the WebdriverIO project. It allows us to set up a simple workflow everywhere and use the same process, independent of the GitHub repository we receive the contribution.
After triggering the workflow providing a pull request number and the expansible amount, the action finds the author of the commit and their respective email and sends an automated generated Email using [resend.com](https://resend.com/):
The receiver can use the code to expense their contribution given the granted amount and by providing the code from the email. The token included in the email is valid for 90 days, after which it expires and cannot be used.
## Usage
Create a workflow file in a WebdriverIO ecosystem project:
```yaml
name: Expense Contribution
on:
workflow_dispatch:
inputs:
prNumber:
description: 'Number of the PR (without #)'
required: true
amount:
description:
'The expense amount you like to grant for the contribution
in $'
required: true
type: choice
options:
- 15
- 25
- 35
- 50
- 100
- 150
- 200
- 250
- 300
- 350
- 400
- 450
- 500
- 550
- 600
- 650
- 700
- 750
- 800
- 850
- 900
- 950
- 1000
jobs:
# (optional): make sure that the expense workflow is triggered
# by someone connected to a certain team, e.g. `technical-steering-committee`
authorize:
runs-on: ubuntu-latest
steps:
- uses: octokit/request-action@v2.1.9
with:
route: GET /orgs/:organisation/teams/:team/memberships/${{ github.actor }}
team: technical-steering-committee
organisation: webdriverio
env:
GITHUB_TOKEN: ${{ secrets.WDIO_BOT_GITHUB_TOKEN }}
expense:
needs: [authorize]
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- name: Run Expense Flow
uses: webdriverio/expense-action@v1
with:
prNumber: ${{ github.event.inputs.prNumber }}
amount: ${{ github.event.inputs.amount }}
env:
RESEND_API_KEY: ${{ secrets.RESEND_API_KEY }}
GH_TOKEN: ${{ secrets.WDIO_BOT_GITHUB_TOKEN }}
```
Then make sure to add `wdio-bot` as project admin so the workflow can properly
label the issue if needed and comment on it.
## Fork it!
If you like to automate the expense process of your project and like to use this GitHub Action, please do so! All you need is to:
- fork the project
- create a GitHub bot account (or use your user account) that has admin access to all repositories you like to use this workflow for
- generate an access token for that account and replace it with `WDIO_BOT_GITHUB_TOKEN` and make it accessible to all repositories in your organization
- update the text within the [mail template](https://github.com/webdriverio/expense-action/blob/main/src/mail.tsx)
---
For more information on WebdriverIO expense policies, take a look at the [governance](https://github.com/webdriverio/webdriverio/blob/main/GOVERNANCE.md#sponsoring-and-donations) docs.