https://github.com/xendit/xendit-api-key-scanner-action
https://github.com/xendit/xendit-api-key-scanner-action
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xendit/xendit-api-key-scanner-action
- Owner: xendit
- License: mit
- Created: 2023-02-16T03:54:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-01T15:23:02.000Z (10 months ago)
- Last Synced: 2025-10-01T17:29:09.963Z (10 months ago)
- Language: JavaScript
- Size: 8.37 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Xendit API Key Scanner
Xendit API Key Scanner is a Github action to detect Xendit API Key in the pull request.
The action will fail if there is any detected Xendit API Key in the changed code in a spesific pull request. The action will give the detail path in Pull Request Comment.
Example of PR Comment :
## Inputs
- `github-token` (Optional) Github token to create PR Comment. By default using github token provided by github action.
## How to use
1. Create config inside `.github/workflow` folder.
example config :
```
name: 'Test - Xendit API Key Detector Action'
on: pull_request
jobs:
scan_job:
runs-on: ubuntu-latest
name: Xendit API Key Detector Action
steps:
- name: Scan Job
uses: xendit/xendit-api-key-scanner-action@v1.0.0
```
using custom `gihtub-token` input (optional) :
```
name: 'Test - Xendit API Key Detector Action'
on: pull_request
jobs:
scan_job:
runs-on: ubuntu-latest
name: Xendit API Key Detector Action
steps:
- name: Scan Job
uses: xendit/xendit-api-key-scanner-action@v1.0.0
with:
github-token:
```
2. Create pull request to test the action
## Limitation
1. Only detect in the Pull Request trigger
## Contributing
Running test suite
```bash
npm install
npm run test
```
Run before open pull request
```bash
npm run prepare
```
For any requests, bug or comments, please [open an issue](https://github.com/xendit/xendit-api-key-scanner-action/issues) or [submit a pull request](https://github.com/xendit/xendit-api-key-scanner-action/pulls).