Skip to content

Commit 7dc86e0

Browse files
arunskurianarunskurian
committed
Adding Code Scan workflows and bug templates
1 parent 86c6fe3 commit 7dc86e0

File tree

6 files changed

+220
-0
lines changed

6 files changed

+220
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '"[DATE] [BUG]"'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
** Expected Behavior**
11+
Describe what should have happened.
12+
13+
** Actual Behavior**
14+
Describe what actually happened.
15+
16+
**Steps To Reproduce the Problem**
17+
Describe in as much detail as possible how to reproduce the problem.
18+
19+
Steps to reproduce the behavior:
20+
1. Go to '...'
21+
2. Click on '....'
22+
3. Scroll down to '....'
23+
4. See error
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Version**
29+
Indicate the relevant versions of components. This may include the package version, operating system version, or other components relevant to the project.
30+
31+
**Additional Context**
32+
Add any other context about the problem here, including additional logs or debugging information if appropriate.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '"[DATE]: [FEATURE NAME]"'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is and why it is important. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen / how you might solve this problem.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any existing workarounds, alternative solutions or features you've considered, and why you think your solution is preferable.
18+
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

‎.github/workflows/codeql.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# CodeQL configuration for the dxi-terraform-provider repo
2+
name: "CodeQL"
3+
4+
on:
5+
push:
6+
branches: [ main, develop ]
7+
pull_request:
8+
branches: [ develop ]
9+
10+
jobs:
11+
analyze:
12+
name: Analyze
13+
runs-on: ubuntu-latest
14+
permissions:
15+
actions: read
16+
contents: read
17+
security-events: write
18+
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
language: [ 'go' ]
23+
24+
steps:
25+
- name: Checkout repository
26+
uses: actions/checkout@v2
27+
28+
- uses: actions/setup-go@v2
29+
with:
30+
go-version: '^1.17.7'
31+
32+
# Initializes the CodeQL tools for scanning.
33+
- name: Initialize CodeQL
34+
uses: github/codeql-action/init@v1
35+
with:
36+
languages: ${{ matrix.language }}
37+
queries: +security-and-quality
38+
39+
40+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
41+
# If this step fails, then you should remove it and run the build manually (see below)
42+
- name: Autobuild
43+
uses: github/codeql-action/autobuild@v1
44+
45+
# ℹ️ Command-line programs to run using the OS shell.
46+
# 📚
47+
48+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
49+
# and modify them (or add more) to build your code if your project
50+
# uses a compiled language
51+
52+
#- run: |
53+
# make bootstrap
54+
# make release
55+
56+
- name: Perform CodeQL Analysis
57+
uses: github/codeql-action/analyze@v1

‎ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '"[DATE] [BUG]"'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
** Expected Behavior**
11+
Describe what should have happened.
12+
13+
** Actual Behavior**
14+
Describe what actually happened.
15+
16+
**Steps To Reproduce the Problem**
17+
Describe in as much detail as possible how to reproduce the problem.
18+
19+
Steps to reproduce the behavior:
20+
1. Go to '...'
21+
2. Click on '....'
22+
3. Scroll down to '....'
23+
4. See error
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Version**
29+
Indicate the relevant versions of components. This may include the package version, operating system version, or other components relevant to the project.
30+
31+
**Additional Context**
32+
Add any other context about the problem here, including additional logs or debugging information if appropriate.

‎ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '"[DATE]: [FEATURE NAME]"'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is and why it is important. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen / how you might solve this problem.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any existing workarounds, alternative solutions or features you've considered, and why you think your solution is preferable.
18+
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

‎workflows/codeql.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# CodeQL configuration for the dxi-terraform-provider repo
2+
name: "CodeQL"
3+
4+
on:
5+
push:
6+
branches: [ main, develop ]
7+
pull_request:
8+
branches: [ develop ]
9+
10+
jobs:
11+
analyze:
12+
name: Analyze
13+
runs-on: ubuntu-latest
14+
permissions:
15+
actions: read
16+
contents: read
17+
security-events: write
18+
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
language: [ 'go' ]
23+
24+
steps:
25+
- name: Checkout repository
26+
uses: actions/checkout@v2
27+
28+
- uses: actions/setup-go@v2
29+
with:
30+
go-version: '^1.17.7'
31+
32+
# Initializes the CodeQL tools for scanning.
33+
- name: Initialize CodeQL
34+
uses: github/codeql-action/init@v1
35+
with:
36+
languages: ${{ matrix.language }}
37+
queries: +security-and-quality
38+
39+
40+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
41+
# If this step fails, then you should remove it and run the build manually (see below)
42+
- name: Autobuild
43+
uses: github/codeql-action/autobuild@v1
44+
45+
# ℹ️ Command-line programs to run using the OS shell.
46+
# 📚
47+
48+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
49+
# and modify them (or add more) to build your code if your project
50+
# uses a compiled language
51+
52+
#- run: |
53+
# make bootstrap
54+
# make release
55+
56+
- name: Perform CodeQL Analysis
57+
uses: github/codeql-action/analyze@v1

0 commit comments

Comments
 (0)