Overview
With this Github action, information on which DevCycle features have been added or removed in a code change will be shown directly on each Pull Request as a comment.
Note: This is intended for pull_request workflow events
Example Output
Usage
Create a new Actions workflow in your GitHub repository (e.g. devcycle-insights.yml) in the .github/workflows directory. In your new file, paste the following code:
on: pull_request
jobs:
dvc-feature-flag-insights:
runs-on: ubuntu-latest
name: Generate DevCycle PR Insights
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: DevCycleHQ/[email protected]
with:
# Token generated by GitHub
github-token: ${{ secrets.GITHUB_TOKEN }}
# Your DevCycle project key
project-key: your-project-key
# Your organization's DevCycle API client ID & secret
client-id: ${{ secrets.DVC_CLIENT_ID }}
client-secret: ${{ secrets.DVC_CLIENT_SECRET }}
We recommend including your DevCycle API credentials and project token as inputs. If included, the PR comment will be enriched with Feature Flag data from DevCycle.
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 |
no | Your DevCycle project key, see Projects |
client-id |
no | Your organization's API client ID, see Organization Settings |
client-secret |
no | 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.
![cpace - nodemon for C/C++ files. Monitor for any changes in your [.c] and [.cpp] application and automatically restart it - perfect for development](https://github.com/Oleshkooo/cpace/raw/main/logo.png){kind=logo}
33 Dec 25, 2022
4 Jun 23, 2022
14 Nov 12, 2022
27 Jan 7, 2023
12 Oct 30, 2022
3 Oct 6, 2022
6 Dec 20, 2022
6 Apr 27, 2021
1 Feb 5, 2022
241 Nov 29, 2022