Skip to content

Commit 8eee5fd

Browse files
committed
Update codes
1 parent f2343da commit 8eee5fd

File tree

16 files changed

+112
-712
lines changed

16 files changed

+112
-712
lines changed

.github/workflows/codeql-analysis.yml

Lines changed: 0 additions & 67 deletions
This file was deleted.

.github/workflows/contributors.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1+
---
12
name: Contributors
23
on:
34
push:
4-
branches:
5-
- main
5+
branches: [main]
66
workflow_dispatch:
7-
inputs:
8-
logLevel:
9-
description: 'manual run'
10-
required: false
11-
default: ''
7+
inputs:
8+
logLevel:
9+
description: manual run
10+
required: false
11+
default: ''
1212
jobs:
1313
contributors:
1414
runs-on: ubuntu-latest
1515
steps:
16-
- uses: bubkoo/contributors-list@v1
16+
- uses: wow-actions/contributors-list@v1
1717
with:
1818
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19-
round: true
19+
round: false
20+
includeBots: true

.github/workflows/deadlink.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: DeadLink
3+
# Controls when the workflow will run
4+
on:
5+
# Allows you to run this workflow manually from the Actions tab
6+
workflow_dispatch:
7+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
8+
jobs:
9+
# This workflow contains a single job called "build"
10+
build:
11+
# The type of runner that the job will run on
12+
runs-on: ubuntu-latest
13+
14+
# Steps represent a sequence of tasks that will be executed as part of the job
15+
steps:
16+
- name: Find Broken Link
17+
uses: hahwul/deadfinder@1.7.1
18+
id: broken-link
19+
with:
20+
command: url
21+
target: https://github.com/hahwul/DevSecOps
22+
- name: Create Markdown Table from JSON
23+
id: create-markdown-table
24+
run: |
25+
echo "## DeadLink Report" > deadlink_report.md
26+
echo "" >> deadlink_report.md
27+
echo "| Target URL | Deadlink |" >> deadlink_report.md
28+
echo "|------------|------------|" >> deadlink_report.md
29+
echo '${{ steps.broken-link.outputs.output }}' | jq -r 'to_entries[] | .key as $k | .value[] | "| \($k) | \(.) |"' >> deadlink_report.md
30+
- name: Read Markdown Table from File
31+
id: read-markdown-table
32+
run: |
33+
table_content=$(cat deadlink_report.md)
34+
echo "TABLE_CONTENT<<EOF" >> $GITHUB_ENV
35+
echo "$table_content" >> $GITHUB_ENV
36+
echo "EOF" >> $GITHUB_ENV
37+
- name: Create an issue
38+
uses: dacbd/create-issue-action@main
39+
with:
40+
token: ${{ secrets.GITHUB_TOKEN }}
41+
title: DeadLink Issue
42+
body: ${{ env.TABLE_CONTENT }}

CONTRIBUTING.md

Lines changed: 55 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,55 @@
1-
## Add contents in diagram
2-
1. fork this repo
3-
2. open DevSecOps.xml using [draw.io](draw.io)
4-
```
5-
1) File > Open(Import) from > Devices
6-
2) Open DevSecOps.xml
7-
```
8-
3. Edit contents
9-
4. Save diagram(xml file) and Export image
10-
```
11-
1) File > Export as > png
12-
```
13-
5. Commit/Push the `DevSecOps.xml` and `DevSecOps.png` files to the your forked repository.
14-
6. Make and Send PR(Pull Request)
15-
16-
## Add contents in README
17-
Please add content and send us PR!
18-
1. fork this repo
19-
2. Edit contents from forked repo
20-
3. Make and Send PR(Pull Request)
21-
22-
## Add tools
23-
1. form this repo
24-
2. clone forked repo
25-
```
26-
$ git clone https://github.com/{your}/DevSecOps
27-
```
28-
3. build contribute tools
29-
```
30-
$ cd DevSecOps/tools
31-
$ make contribute
32-
```
33-
4. Add tool with `./add-tool`
34-
```
35-
$ ./add-tool -url https://github.com/zaproxy/zaproxy
36-
```
37-
5. Distribute README.md with `./distribute-readme`
38-
```
39-
$ ./distribute-readme
40-
```
41-
6. commit and push `data.json` and `README.md`
42-
```
43-
$ git add data.json README.md ; git commit -m "commit and push" ; git push
44-
```
45-
7. Make and Send PR(Pull Request)
1+
# Contributing to DevSecOps
2+
3+
Thank you for your interest in contributing to our DevSecOps project! This document provides guidelines for different types of contributions.
4+
5+
## Table of Contents
6+
- [Updating the DevSecOps Diagram](#updating-the-devsecops-diagram)
7+
- [Contributing to the Documentation](#contributing-to-the-documentation)
8+
- [Adding Tools to the Repository](#adding-tools-to-the-repository)
9+
- [Creating a Pull Request](#creating-a-pull-request)
10+
11+
## Updating the DevSecOps Diagram
12+
13+
1. Fork this repository to your GitHub account.
14+
2. Open the diagram file using [draw.io](https://draw.io):
15+
- Select **File > Open from > Device**
16+
- Choose the `DevSecOps.xml` file from your forked repository
17+
3. Make your desired edits to the diagram.
18+
4. Save both the XML source and export a PNG image:
19+
- Save the XML: **File > Save** or **File > Save As**
20+
- Export as PNG: **File > Export as > PNG**
21+
5. Commit both the updated `DevSecOps.xml` and `DevSecOps.png` files to your forked repository.
22+
6. Create a Pull Request (see [Creating a Pull Request](#creating-a-pull-request) section).
23+
24+
## Contributing to the Documentation
25+
26+
1. Fork this repository to your GitHub account.
27+
2. Make your changes to the README.md or other documentation files.
28+
3. Create a Pull Request with your improvements.
29+
30+
## Adding Tools to the Repository
31+
32+
1. Fork this repository to your GitHub account.
33+
2. Clone your forked repository:
34+
```bash
35+
git clone https://github.com/YOUR-USERNAME/DevSecOps
36+
cd DevSecOps/tools
37+
```
38+
3. Update the tools directory and corresponding `README.md` file.
39+
4. Commit and push your changes:
40+
```bash
41+
git add .
42+
git commit -m "Add/update tools: BRIEF DESCRIPTION" -s
43+
git push
44+
```
45+
5. Create a Pull Request (see next section).
46+
47+
## Creating a Pull Request
48+
49+
1. Navigate to your forked repository on GitHub.
50+
2. Click on "Pull Request" and then "New Pull Request".
51+
3. Ensure the base repository is the original DevSecOps repository and the head repository is your fork.
52+
4. Provide a clear title and description for your Pull Request, explaining the changes you've made.
53+
5. Submit the Pull Request.
54+
55+
Thank you for contributing to make this project better!

justfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
setup:
2+
brew install yamlfix
3+
4+
fix:
5+
yamlfix .github/workflows/*

tools/Makefile

Lines changed: 0 additions & 40 deletions
This file was deleted.

tools/add-tool

-4.99 MB
Binary file not shown.

0 commit comments

Comments
 (0)