|Table of Contents|
SoftaCheck is a tool for the analysis of C/C++ code. Run static analysis for your GitHub repository and generate Doxygen documentation. SoftaCheck supports GitHub as a code hosting platform.
Getting started with GitHub
To start analyzing your code go to the SoftaCheck and sign in with your GitHub Account
SoftaCheck will connect your GitHub account and ask for permission to access your repositories.
Welcome to SoftaCheck
Once you’ve successfully logged in you'll have the dashboard with all your GitHub repositories list. You can add any repository by selecting and clicking on import
Choose a plan
Once you sign up with SoftaCheck you’ll opt-in for a Free plan which provides unlimited access to public repositories and one private repository. In order to run analysis against unlimited private repositories and support you can opt-in for the paid plan
Go to Profile > Plans
Now you can import the repository (individual or multiple from GitHub) that you want to analyze. On Dashboard, you can see the list of repositories and already imported repositories.
You can select the repository you want to analyze and click Import
Your analysis results
Once completed you can view the detailed analysis here (Link to Your First Analysis)
Your First Analysis
Once you import your repository in SoftaCheck, it will run code analysis against your code.
By default, SoftaCheck will run analysis against your default branch that can be main or master
From now on any change you made towards your default branch will be analyzed, it can be direct commit, merge request, or branch merge.
You can check details issue that SoftaCheck find in your code
In addition to running analysis on your default branch, SoftaCheck will also run analysis against individual pull requests that branches are enabled. Any pull request made towards the branch is checked against the repository settings. If that branch is enabled for analysis, SoftaCheck will run the same.
Code analysis happens before you merge the pull request in order to catch any issues. The analysis result of the pull requestis displayed in the Pull Request section.
The Branches will display all the active branches of the repository. Initially, the default branch will be active for the repository. You can also configure here other branches to run the analysis. Once configured for any future changes to that branch will analyze with SoftaCheck