📖 Update docs on how to run and debug locally #2587
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabibguti
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2587 +/- ##
=======================================
Coverage 41.27% 41.27%
=======================================
Files 123 123
Lines 10043 10043
=======================================
Hits 4145 4145
Misses 5602 5602
Partials 296 296 |
|
Integration tests success for |
gabibguti
temporarily deployed
to
integration-test
GitHub Actions
Inactive
|
Integration tests success for |
naveensrinivasan
force-pushed
the
docs/how-to-local-run-and-debug
branch
from
d6014ff
to
69f75f1
Compare
naveensrinivasan
had a problem deploying
to
integration-test
GitHub Actions
Failure
|
Stale pull request message |
naveensrinivasan
force-pushed
the
docs/how-to-local-run-and-debug
branch
from
69f75f1
to
9056020
Compare
naveensrinivasan
temporarily deployed
to
integration-test
GitHub Actions
Inactive
|
Integration tests success for |
naveensrinivasan
approved these changes
Jan 21, 2023
|
Stale pull request message |
Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
naveensrinivasan
force-pushed
the
docs/how-to-local-run-and-debug
branch
from
9056020
to
f539969
Compare
naveensrinivasan
temporarily deployed
to
integration-test
GitHub Actions
Inactive
|
Integration tests success for |
raghavkaul
pushed a commit
to raghavkaul/scorecard
that referenced
this pull request
Feb 9, 2023
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
Shofiya2003
pushed a commit
to Shofiya2003/scorecard
that referenced
this pull request
Mar 10, 2023
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Shofiya2003 <shofiyabootwala@gmail.com>
Shofiya2003
pushed a commit
to Shofiya2003/scorecard
that referenced
this pull request
Mar 10, 2023
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Shofiya2003 <shofiyabootwala@gmail.com>
raghavkaul
pushed a commit
to raghavkaul/scorecard
that referenced
this pull request
Apr 4, 2023
* Change docs on how to run and debug locally Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> * Remove docs section on debug Go lang Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com> Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Gabriela Gutierrez gabigutierrez@google.com
What kind of change does this PR introduce?
Update docs on how to how to run Scorecard locally and debug Go files by logging to console or to an output file.
What is the current behavior?
Currently the docs don't explain how to run Scorecard locally, only how to build it. I added instructions on how to run it locally. The other thing is there are currently no debug instructions. Debugging is more Go language related than Scorecard related but I thought adding some debug instructions would be useful.
What is the new behavior (if this is a feature change)?**
Which issue(s) this PR fixes
None.
Special notes for your reviewer
Does this PR introduce a user-facing change?
For user-facing changes, please add a concise, human-readable release note to
the
release-note(In particular, describe what changes users might need to make in their
application as a result of this pull request.)