Skip to content

Commit

Permalink
Merge pull request #3 from ferrous-systems/amanjeev/improvements
Browse files Browse the repository at this point in the history
gh vs cli explanation for authenticate
  • Loading branch information
amanjeev authored Oct 28, 2024
2 parents ef7231e + ce952b6 commit 64602a9
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,13 @@ criticalup --help
- Get the CriticalUp Token to authenticate
- Add the CriticalUp Token to GitHub Action secrets

In your GitHub Action you can use the secret now as:
In the following command to authenticate, paste the token in place of `<CRITICALUP_TOKEN>`:

```sh
criticalup auth set <CRITICALUP_TOKEN>
```

**Note:** In your GitHub Action you can use the secret as:

```shell
criticalup auth set ${{ secrets.CRITICALUP_TOKEN }}
Expand Down Expand Up @@ -172,6 +178,12 @@ The CriticalUp Token you got from the [Ferrocene Customer Portal] must be set in
- Click 'New repository secret'.
- Add Name as `CRITICALUP_TOKEN` and past the token from [Ferrocene Customer Portal] in the 'Secret' text area.

In your GitHub Action, now you can use the secret as:

```shell
criticalup auth set ${{ secrets.CRITICALUP_TOKEN }}
```

### Create a simple GitHub Action

An example of a fully working Github CI workflow file can be found in the workflow file [`build.yml`] of this demo project.
Expand Down

0 comments on commit 64602a9

Please sign in to comment.