From 7dc86e088d2c6f9739bd5be43a255e41d47e362b Mon Sep 17 00:00:00 2001 From: arunskurian <70768312+arunskurian@users.noreply.github.com> Date: Tue, 5 Apr 2022 21:11:13 -0400 Subject: [PATCH] Adding Code Scan workflows and bug templates --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++ .github/workflows/codeql.yml | 57 +++++++++++++++++++++++ ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++ ISSUE_TEMPLATE/feature_request.md | 21 +++++++++ workflows/codeql.yml | 57 +++++++++++++++++++++++ 6 files changed, 220 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/codeql.yml create mode 100644 ISSUE_TEMPLATE/bug_report.md create mode 100644 ISSUE_TEMPLATE/feature_request.md create mode 100644 workflows/codeql.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e61adad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '"[DATE] [BUG]"' +labels: '' +assignees: '' + +--- + +** Expected Behavior** +Describe what should have happened. + +** Actual Behavior** +Describe what actually happened. + +**Steps To Reproduce the Problem** +Describe in as much detail as possible how to reproduce the problem. + +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Version** +Indicate the relevant versions of components. This may include the package version, operating system version, or other components relevant to the project. + +**Additional Context** +Add any other context about the problem here, including additional logs or debugging information if appropriate. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b13badd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '"[DATE]: [FEATURE NAME]"' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is and why it is important. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen / how you might solve this problem. + +**Describe alternatives you've considered** +A clear and concise description of any existing workarounds, alternative solutions or features you've considered, and why you think your solution is preferable. + + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..aa13692 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,57 @@ +# CodeQL configuration for the dxi-terraform-provider repo +name: "CodeQL" + +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ develop ] + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'go' ] + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - uses: actions/setup-go@v2 + with: + go-version: '^1.17.7' + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + queries: +security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/ISSUE_TEMPLATE/bug_report.md b/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e61adad --- /dev/null +++ b/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '"[DATE] [BUG]"' +labels: '' +assignees: '' + +--- + +** Expected Behavior** +Describe what should have happened. + +** Actual Behavior** +Describe what actually happened. + +**Steps To Reproduce the Problem** +Describe in as much detail as possible how to reproduce the problem. + +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Version** +Indicate the relevant versions of components. This may include the package version, operating system version, or other components relevant to the project. + +**Additional Context** +Add any other context about the problem here, including additional logs or debugging information if appropriate. diff --git a/ISSUE_TEMPLATE/feature_request.md b/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b13badd --- /dev/null +++ b/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '"[DATE]: [FEATURE NAME]"' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is and why it is important. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen / how you might solve this problem. + +**Describe alternatives you've considered** +A clear and concise description of any existing workarounds, alternative solutions or features you've considered, and why you think your solution is preferable. + + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/workflows/codeql.yml b/workflows/codeql.yml new file mode 100644 index 0000000..aa13692 --- /dev/null +++ b/workflows/codeql.yml @@ -0,0 +1,57 @@ +# CodeQL configuration for the dxi-terraform-provider repo +name: "CodeQL" + +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ develop ] + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'go' ] + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - uses: actions/setup-go@v2 + with: + go-version: '^1.17.7' + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + queries: +security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1