Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 1302b5a

Browse files
authored
Merge branch 'master' into feature/docs-declarative-combined-scans
2 parents e1ad99e + 33282ef commit 1302b5a

File tree

28 files changed

+3109
-317
lines changed

28 files changed

+3109
-317
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# secureCodeBox – v2 ALPHA
1+
# secureCodeBox – v2 Beta
22

33
<p align="center">
44
<img alt="secureCodeBox Logo" src="./docs/resources/securecodebox-logo.svg" width="500px">
@@ -7,25 +7,28 @@
77

88
<p align="center">
99
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
10-
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="Latest GitHub Release" src="https://img.shields.io/github/release/secureCodeBox/secureCodeBox.svg"></a>
10+
<a href="https://github.com/secureCodeBox/secureCodeBox-v2/releases/tag/v2.0.0-rc.1"><img alt="Preview GitHub Release" src="https://img.shields.io/badge/release-v2.0.0%7Erc.1-blue.svg"></a>
1111
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"></a>
1212
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"></a>
1313
</p>
1414
<p align="center">
15-
<a href="https://github.com/secureCodeBox/secureCodeBox-v2-alpha/actions?query=workflow%3ACI"><img alt="Build" src="https://github.com/secureCodeBox/secureCodeBox-v2-alpha/workflows/CI/badge.svg"></a>
16-
<a href="https://codeclimate.com/github/secureCodeBox/secureCodeBox-v2-alpha/test_coverage"><img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/b6bf3af707671b5e5251/test_coverage" /></a>
17-
<a href="https://snyk.io/test/github/secureCodeBox/secureCodeBox-v2-alpha/"><img alt="Known Vulnerabilities" src="https://snyk.io/test/github/secureCodeBox/secureCodeBox-v2-alpha/badge.svg"></a>
15+
<a href="https://github.com/secureCodeBox/secureCodeBox-v2/actions?query=workflow%3ACI"><img alt="Build" src="https://github.com/secureCodeBox/secureCodeBox-v2/workflows/CI/badge.svg"></a>
16+
<a href="https://codeclimate.com/github/secureCodeBox/secureCodeBox-v2/test_coverage"><img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/b6bf3af707671b5e5251/test_coverage" /></a>
17+
<a href="https://snyk.io/test/github/secureCodeBox/secureCodeBox-v2/"><img alt="Known Vulnerabilities" src="https://snyk.io/test/github/secureCodeBox/secureCodeBox-v2/badge.svg"></a>
1818
</p>
1919

20-
**NOTE**: This Repository contains a **work in progress** preview of the planned next major secureCodeBox Release. You can find the current **stable release** here [https://github.com/secureCodeBox/secureCodeBox](https://github.com/secureCodeBox/secureCodeBox). The release of version 2.0 is still at least some month away but you can already get a sneak peak here 😀. The release will contain a major architecture change which will not be backward compatible. More details will follow soon in a series of blog articles.
20+
**NOTE**: This Repository contains the stable beta preview of the next major secureCodeBox (SCB) Release v2.
21+
You can find the current **stable release** here [https://github.com/secureCodeBox/secureCodeBox](https://github.com/secureCodeBox/secureCodeBox).
22+
23+
_The major release of SCB version 2.0 will be available in the next weeks._ The release will contain a major architecture change which will not be backward compatible. More details will follow soon in a series of blog articles.
2124

2225
> _secureCodeBox_ is a kubernetes based, modularized toolchain for continuous security scans of your software project. Its goal is to orchestrate and easily automate a bunch of security-testing tools out of the box.
2326
2427
## Overview
2528

2629
<!-- toc -->
2730

28-
- [secureCodeBox – v2 ALPHA](#securecodebox--v2-alpha)
31+
- [secureCodeBox – v2 Beta](#securecodebox--v2-beta)
2932
- [Overview](#overview)
3033
- [Purpose of this Project](#purpose-of-this-project)
3134
- [Quickstart](#quickstart)

docs/developer-guide/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: "Developer Guide"
3+
path: "docs/developer-guide"
4+
category: "develop"
5+
---
6+
7+
<!-- end -->
8+
19
# Extending secureCodeBox
210

311
## Developing the SCB Operator
@@ -86,21 +94,32 @@ cd operator
8694
make run
8795
```
8896

89-
## How to a New Security Scanner
97+
## How to add a New Security Scanner
9098

9199
### ScanType Definition
100+
> **Following...**
92101
93102
### Parsing SDK
94103

104+
1. Install the dependencies `npm install`
105+
2. Update the parser function here: `./parser/parser.js`
106+
3. Update the parser tests here: `./parser/parser.test.js`
107+
4. Run the test suite: `npm test`
108+
95109
## How to Integrate a New Hook
110+
> **Following...**
96111
97112
### HookType Definition
113+
> **Following...**
98114
99115
### Hook SDK
116+
> **Following...**
100117
101118
## Guidelines
119+
> **Following...**
102120
103121
### Coding Guidelines
122+
> **Following...**
104123
105124
#### JSON
106125

0 commit comments

Comments
 (0)