Skip to content

Commit f428af5

Browse files
authored
feat: provide debug output by default (#37)
This change updates the action to provide debug level output by default. The documentation was updated to match.
1 parent 3db228c commit f428af5

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,13 @@ jobs:
153153
continue-on-error: true # This is the job level
154154
steps:
155155
- name: Checkout the repo with full history
156-
uses: actions/checkout@v3
156+
uses: actions/checkout@v4
157157
with:
158158
fetch-depth: 0 # Not really needed for `--all-deps`
159159
- name: Analyze lockfile
160160
continue-on-error: true # This is the step level
161161
uses: phylum-dev/phylum-analyze-pr-action@v2
162162
with:
163163
phylum_token: ${{ secrets.PHYLUM_TOKEN }}
164-
cmd: phylum-ci --all-deps
164+
cmd: phylum-ci -vv --all-deps
165165
```

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ jobs:
110110
```
111111
112112
This configuration contains a single job, with two steps, that will only run on pull request events.
113-
It does not override any of the `phylum-ci` arguments, which are all either optional or default to secure values.
114-
Let's take a deeper dive into each part of the configuration:
113+
It provides debug output but otherwise does not override any of the `phylum-ci` arguments, which are all either
114+
optional or default to secure values. Let's take a deeper dive into each part of the configuration:
115115

116116
### Workflow and Job names
117117

@@ -197,7 +197,7 @@ See the [GitHub documentation][scopes] for more info.
197197
```
198198

199199
When using a personal access token (PAT) instead, the token should be created with the `repo` scope or
200-
minimally the with `public_repo` scope if private repositories will not be used with the PAT.
200+
minimally with the `public_repo` scope if private repositories will not be used with the PAT.
201201
See the [GitHub documentation][PAT] for more info.
202202

203203
```yaml
@@ -314,13 +314,13 @@ view the [script options output][script_options] for the latest release.
314314

315315
# NOTE: These are examples. Only one `cmd` entry line is expected.
316316
#
317-
# Use the defaults for all the arguments.
318-
# The default behavior is to only analyze newly added dependencies against
319-
# the active policy set at the Phylum project level.
317+
# Use the defaults for all the arguments and provide debug level output.
318+
# The default behavior is to only analyze newly added dependencies
319+
# against the active policy set at the Phylum project level.
320320
# This entry does not have to be specified since it is the default.
321-
cmd: phylum-ci
322-
# Provide debug level output.
323321
cmd: phylum-ci -vv
322+
# Same as the previous entry, but without debug level output.
323+
cmd: phylum-ci
324324
# Consider all dependencies in analysis results instead of just the newly added ones.
325325
# The default is to only analyze newly added dependencies, which can be useful for
326326
# existing code bases that may not meet established policy rules yet,
@@ -342,7 +342,7 @@ view the [script options output][script_options] for the latest release.
342342
# Analyze all dependencies in audit mode, to gain insight without failing builds.
343343
cmd: phylum-ci --all-deps --audit
344344
# Install a specific version of the Phylum CLI.
345-
cmd: phylum-ci --phylum-release 4.8.0 --force-install
345+
cmd: phylum-ci --phylum-release 6.5.0 --force-install
346346
# Mix and match for your specific use case.
347347
cmd: |
348348
phylum-ci \

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ inputs:
2424
cmd:
2525
description: The phylum-ci command line to pass to the Docker container's entrypoint
2626
required: true
27-
default: phylum-ci
27+
default: phylum-ci -vv
2828
runs:
2929
using: docker
3030
image: docker://ghcr.io/phylum-dev/phylum-ci:latest

0 commit comments

Comments
 (0)