Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #3

Closed
wants to merge 1 commit into from
Closed

Update README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# action-install-nctl-scan GitHub Action

This action enables you to install nctl.
`nctl` is a CLI by Nirmata that can be used standalone to scan config files (Kubernetes manifests, IaC files, Dockerfile, JSON).

To learn more about `nctl`, refer to the [official documentation](https://docs.nirmata.io/nctl/).

# Usage

This action currently supports GitHub-provided Linux runner.

Example
Add the following entry to your Github workflow YAML file:

```yaml
jobs:
Expand All @@ -15,15 +17,11 @@ jobs:

permissions: {}

name: Install NCTL scan
name: Install nctl
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
token: ${{ secrets.PAT }}
release: 3.3.6
- name: Install NCTL scan
uses: ./
- name: Check install
- name: Install nctl
uses: nirmata/[email protected] # pin to the preferred release

- name: Check nctl version
run: nctl version
```
```
Loading