Skip to content

Commit e5abf6c

Browse files
authored
docs: update docs with new tag, fix some links etc
1 parent 1a0766d commit e5abf6c

File tree

5 files changed

+15
-13
lines changed

5 files changed

+15
-13
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
- [Getting Started](./getting-started.md) - Recommended if you are just starting to explore the NowSecure Action and have a GHAS license
44
- [GitHub Issues Integration](./issues.md) - Recommended if you do not have a GHAS license and want to integrate NowSecure alerts into GitHub issues
55
- [Advanced Configurations](./advanced-configurations.md) - Details addtional configuration options for the NowSecure Action
6-
- [Migrating to V3](./migrating-to-v3.md) - For users who have existing NowSecure Action integration and want to upgrade to V3
6+
- [Migrating from < V3](./migrating-to-v3.md) - For users who have an early version of the NowSecure Action integration and want to upgrade to a version greater than V3
77

8-
Example workflows can be found in the [workflows](../workflows) folder.
8+
Example workflows can be found in the [workflows](../.github/workflows) folder.

docs/advanced-configurations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The `example-workflow-config` can then be referenced by your workflow:
7373

7474
```yml
7575
- name: NowSecure
76-
uses: nowsecure/nowsecure-action/convert-sarif@v3
76+
uses: nowsecure/nowsecure-action/convert-sarif@v5
7777
timeout-minutes: 60
7878
with:
7979
# Specify a config in .nsconfig.yml
@@ -125,7 +125,7 @@ hash of the commit that triggered the action:
125125
```yml
126126
- id: upload
127127
name: NowSecure upload app
128-
uses: nowsecure/nowsecure-action/upload-app@v3
128+
uses: nowsecure/nowsecure-action/upload-app@v5
129129
with:
130130
version_string: ${{ github.sha }}
131131
platform_token: ${{ secrets.NS_TOKEN }}
@@ -157,7 +157,7 @@ and "Failed Dynamic Analysis" due to the lack of a dynamic analysis.
157157
```yml
158158
- id: upload
159159
name: NowSecure upload app
160-
uses: nowsecure/nowsecure-action/upload-app@v3
160+
uses: nowsecure/nowsecure-action/upload-app@v5
161161
with:
162162
analysis_type: static
163163
platform_token: ${{ secrets.NS_TOKEN }}
@@ -198,7 +198,7 @@ Note that this input is available on both the `convert-sarif` and `create-issues
198198

199199
```yml
200200
- name: NowSecure download report
201-
uses: nowsecure/nowsecure-action/convert-sarif@v3
201+
uses: nowsecure/nowsecure-action/convert-sarif@v5
202202
with:
203203
report_id: ${{ needs.scan.outputs.report_id }}
204204
platform_token: ${{ secrets.NS_TOKEN }}
@@ -209,7 +209,7 @@ Note that this input is available on both the `convert-sarif` and `create-issues
209209

210210
```yml
211211
- name: NowSecure download report
212-
uses: nowsecure/nowsecure-action/create-issues@v3
212+
uses: nowsecure/nowsecure-action/create-issues@v5
213213
with:
214214
report_id: ${{ needs.scan.outputs.report_id }}
215215
platform_token: ${{ secrets.NS_TOKEN }}

docs/getting-started.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ To use this action an active NowSecure Platform account is required. If you **_a
1919

2020
## Basic Configuration
2121

22+
> Note: The NowSecure action is dependent upon the results of the NowSecure assessment. If the assessment fails, the action will also fail.
23+
2224
### For a New Workflow
2325

2426
For the easiest setup, see the [example annotated workflow](../.github/workflows/basic-example.yml) in this repository's `./github/workflows/` directory.
@@ -51,7 +53,7 @@ scan:
5153

5254
- id: upload
5355
name: NowSecure upload app
54-
uses: nowsecure/nowsecure-action/upload-app@v3
56+
uses: nowsecure/nowsecure-action/upload-app@v5
5557
with:
5658
platform_token: ${{ secrets.NS_TOKEN }}
5759
# TODO: Replace application path.

docs/issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ scan:
3232

3333
- id: upload
3434
name: NowSecure Upload App
35-
uses: nowsecure/nowsecure-action/upload-app@v3
35+
uses: nowsecure/nowsecure-action/upload-app@v5
3636
with:
3737
platform_token: ${{ secrets.NS_TOKEN }}
3838
# TODO: Replace application path.
@@ -55,7 +55,7 @@ process:
5555
5656
- id: createIssues
5757
name: Create NowSecure issues
58-
uses: nowsecure/nowsecure-action/create-issues@v3
58+
uses: nowsecure/nowsecure-action/create-issues@v5
5959
timeout-minutes: 60
6060
with:
6161
report_id: ${{ needs.scan.outputs.report_id }}

docs/migrating-to-v3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Migrating to V3
1+
# Migrating from Earlier Versions
22

33
Migrating from a previous version to V3 is straightforward. However there are two breaking changes in V3 that need to be addressed prior to migrating:
44

5-
1. Change all tag references (e.g. `@v1` or `@v2`) to `@v3`
6-
2. Remove all usages of `token` and replace them with `platform_token` in the `with:` clause
5+
1. Change all tag references (e.g. `@v1` or `@v2`) to the latest version available.
6+
2. Remove all usages of `token` and replace them with `platform_token` in the `with:` clause.
77

88
Additionally, if your workflow was based off of our example workflows you will
99
need to update the `github/codeql-action/upload-sarif` action to avoid warnings

0 commit comments

Comments
 (0)