Overview
With this Github action, your DevCycle dashboard will be updated to display code snippets for each DevCycle variable usage within your project.
Note: This is intended to run when pushing changes to your main branch
Example Output
Usage
Create a new Actions workflow in your GitHub repository (e.g. devcycle-usages.yml) in the .github/workflows directory. In your new file, paste the following code:
on:
push:
branches: [main]
jobs:
dvc-code-usages:
runs-on: ubuntu-latest
name: Fetch DevCycle Code Usages
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: DevCycleHQ/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
client-id: ${{ secrets.DVC_CLIENT_ID }}
client-secret: ${{ secrets.DVC_CLIENT_SECRET }}
project-key: app-devcycle-com
Your DevCycle API credentials and project token are required to update the DevCycle dashboard.
When referencing your API client ID and secret, we recommend using GitHub Secrets to store your credentials securely.
Inputs
| input | required | description |
|---|---|---|
github-token |
yes | The GitHub Actions token e.g. secrets.GITHUB_TOKEN |
project-key |
yes | Your DevCycle project key, see Projects |
client-id |
yes | Your organization's API client ID, see Organization Settings |
client-secret |
yes | Your organization's API client secret, see Organization Settings |
Configuration
The patterns used to identify references to variables in your code are fully customizable. This action uses the DevCycle CLI under the hood, for details on how to configure the pattern matcher see the CLI configuration.