Skip to content

Commit

Permalink
Merge pull request #3580 from AElfProject/release/2.0.1
Browse files Browse the repository at this point in the history
Add a SonarQube configuration file to implement static code analysis
  • Loading branch information
JimAelf authored Jun 28, 2024
2 parents 3806c18 + ac62f13 commit 0a8805b
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 31 deletions.
42 changes: 22 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
name: 👾 Bug Report
about: Report a bug or issue with the project.
title: ''
labels: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
### Description
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
### Steps To Reproduce
1. Log in...
2. Ensure that...
3. Allow a long period of inactivity to pass...
4. Observe that...
5. Attempt to log in...

**Expected behavior**
A clear and concise description of what you expected to happen.
### Current Behavior
- After the period of inactivity...
- When the user tries to log in using another method...
- This causes a bug due to...

**Screenshots**
If applicable, add screenshots to help explain your problem.
### Expected Behavior
- After a long period of inactivity...
- When a user logs in successfully...
- This ensures that only...

**Environment (please complete the following information):**
- OS and version: [e.g. Ubuntu 18.04]
- Dotnet core version [e.g. 2.2.106]

**Additional context**
Add any other context about the problem here.
### Environment
- Platform: PC
- Node: v18.18.0
- Browser: Chrome 126.0.6478.56
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
blank_issues_enabled: false
issue_template:
- name: 👾 Bug Report
description: Report a bug or issue with the project.
labels: ["bug"]
template: bug_report.md
- name: 💡 Feature Request
description: Create a new ticket for a new feature request.
labels: ["enhancement"]
template: feature_request.md
29 changes: 18 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
---
name: Feature request
about: Suggest an idea for this project
name: 💡 Feature Request
about: Create a new ticket for a new feature request
title: ''
labels: ''
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
### Expected Behavior
Describe the expected behavior here.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
### Specifications
As a `user`, I would like to `action` so that `reason`.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Features:**
- describe feature details here.

**Additional context**
Add any other context or screenshots about the feature request here.
**Development Tasks:**
- [ ] Task 1
- [ ] Task 2

### Dependencies
List any dependencies that are required for this feature by providing links to the issues or repositories.

### References
List any references that are related to this feature request.
49 changes: 49 additions & 0 deletions .github/workflows/sonarqube.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
on:
pull_request:
types: [opened, synchronize, reopened]

name: PR Static Code Analysis
jobs:
static-code-analysis:
runs-on: ubuntu-latest
steps:
- name: Code Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-dotnet@v4
with:
dotnet-version: '7.0'
- name: Create temporary global.json
run: echo '{"sdk":{"version":"7.0.410"}}' > ./global.json
- name: Set up JDK 17
uses: actions/setup-java@v1
with:
java-version: 17
- name: Cache SonarQube packages
uses: actions/cache@v1
with:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
restore-keys: ${{ runner.os }}-sonar
- name: Cache SonarQube scanner
id: cache-sonar-scanner
uses: actions/cache@v1
with:
path: ./.sonar/scanner
key: ${{ runner.os }}-sonar-scanner
restore-keys: ${{ runner.os }}-sonar-scanner
- name: Install SonarScanner for .NET
run: dotnet tool update dotnet-sonarscanner --tool-path ./.sonar/scanner
- name: Add .NET global tools to PATH
run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
- name: Install protobuf
run: sudo apt-get update && sudo apt-get install -y protobuf-compiler
- name: Begin SonarQube analysis
run: |
./.sonar/scanner/dotnet-sonarscanner begin /k:"AElf" /d:sonar.host.url="${{ secrets.SONAR_HOST_URL }}" /d:sonar.token="${{ secrets.SONAR_TOKEN }}"
dotnet build AElf.All.sln
./.sonar/scanner/dotnet-sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}"

0 comments on commit 0a8805b

Please sign in to comment.