Skip to content

Commit e1b4f6f

Browse files
authored
Merge pull request #4 from Probely/update-readme
Add a summary of the Probely Github Action
2 parents a824bcc + 3abc4ba commit e1b4f6f

2 files changed

Lines changed: 42 additions & 4 deletions

File tree

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,43 @@
1-
# Probely GitHub Action
1+
# Probely Target Scan Action
22

3-
The Probely GitHub Action allows for easy integration of application and API security testing into your CI/CD pipeline.
3+
The Target Scan Action provides an easy and efficient integration of Dynamic Application Security Testing (DAST) done with [Probely](http://probely.com) into your CI pipelines in GitHub.
44

5-
Know more about Probely [here](https://probely.com/).
5+
![image](https://github.com/Probely/probely-github-action/assets/55719546/aa86508c-9293-44d8-8b86-38813b074e06)
6+
7+
## About Probely’s DAST
8+
9+
Probely’s DAST scanner automates and scales web applications and APIs security testing:
10+
* Detects over 30,000 potential security vulnerabilities.
11+
* Reports the vulnerabilities that matter due to the near-zero number of false positives (0.06% in 2022).
12+
* Produces reports of the vulnerabilities found with detailed instructions on how to fix them.
13+
14+
Read more details on [our Product page](https://probely.com/product/).
15+
16+
## About the Target Scan Action
17+
18+
The Target Scan Action is the piece that automates Probely’s security testing integrated into your CI pipeline. It is configured in GitHub Actions to execute security tests on every commit to your project’s main branch.
19+
20+
![image](https://github.com/Probely/probely-github-action/assets/55719546/e8d05375-187c-4b91-bc86-e76de763210e)
21+
22+
This default behavior can, however, be changed and adjusted in GitHub Actions to meet your specific CI needs.
23+
24+
## Usage
25+
26+
### Register
27+
28+
If you are not registered yet, [get started for free](https://probely.com/?utm_source=google&utm_medium=cpc&utm_campaign=RP+-+Brand+-+Exact&utm_term=probely&hsa_ad=654489877632&hsa_net=adwords&hsa_grp=147353173825&hsa_tgt=kwd-804841504705&hsa_acc=6027994897&hsa_kw=probely&hsa_cam=19958547983&hsa_mt=p&hsa_src=g&hsa_ver=3&gad_source=1&gclid=CjwKCAiAjfyqBhAsEiwA-UdzJBCZNCM-RkWkJ5kXLgP6SY2hYlx4GqSgZhB4IVwFGUHOtV3imerAAxoCVLgQAvD_BwE) and create an account in Probely.
29+
For more details, read this article on [how the free trial works](https://help.probely.com/en/articles/6842482-understand-how-the-trial-works).
30+
31+
### Add the Target
32+
33+
Once registered, log in to the [Probely app](https://help.probely.com/en/articles/6842482-understand-how-the-trial-works), and add the target for the web application or API you want to do the security testing.
34+
See this tutorial on [how to add a target](https://help.probely.com/en/articles/5733114-how-to-add-a-target).
35+
36+
### Integrate
37+
38+
Once registered and with the target created in Probely, set up the Target Scan Action integration with your CI pipeline in GitHub by following this tutorial on [how to integrate Probely with GitHub Actions](https://help.probely.com/en/articles/8608589-how-to-integrate-probely-with-github).
39+
40+
## Contact Us
41+
42+
If you have any issues or questions, email us to support@probely.com.
43+
If you want to know more about Probely, request a demo on [our website](https://probely.com/).

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# action.yml
2-
name: 'Probely security scan'
2+
name: 'Probely Security Scan'
33
description: 'Scan your application for vulnerabilities with Probely'
44
inputs:
55
api-key:

0 commit comments

Comments
 (0)