package-checker.sh/.github/workflows/example-usage.yml at main · maxgfr/package-checker.sh · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
name: Example - Using Reusable Workflow

on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

jobs:
  # Example 1: Simple check with JSON source
  check-with-json:
    name: Check with JSON
    uses: ./.github/workflows/reusable-check.yml
    with:
      source: "https://raw.githubusercontent.com/maxgfr/package-checker.sh/main/test-fixtures/test-vulnerabilities.json"
      fail-on-vulnerabilities: false

  # Example 2: Check with CSV source
  check-with-csv:
    name: Check with CSV
    uses: ./.github/workflows/reusable-check.yml
    with:
      source: "https://raw.githubusercontent.com/maxgfr/package-checker.sh/main/test-fixtures/test-vulnerabilities.csv"
      source-format: "csv"
      csv-columns: "name,versions"
      fail-on-vulnerabilities: false

  # Example 3: Check specific directory without failing
  check-without-fail:
    name: Check Without Failing Build
    uses: ./.github/workflows/reusable-check.yml
    with:
      source: "./vulnerabilities.json"
      working-directory: "./test-fixtures/npm-project"
      fail-on-vulnerabilities: false

  # Example 4: Check with custom arguments
  check-with-args:
    name: Check with Custom Args
    uses: ./.github/workflows/reusable-check.yml
    with:
      source: "./vulnerabilities.json"
      additional-args: "--no-config"
      fail-on-vulnerabilities: false

  # Example 5: Check with built-in GHSA feed
  check-with-ghsa:
    name: Check with GHSA Feed
    uses: ./.github/workflows/reusable-check.yml
    with:
      use-ghsa: true
      fail-on-vulnerabilities: false

  # Example 6: Check with built-in OSV feed
  check-with-osv:
    name: Check with OSV Feed
    uses: ./.github/workflows/reusable-check.yml
    with:
      use-osv: true
      fail-on-vulnerabilities: false

  # Example 7: Check with both built-in feeds (GHSA and OSV)
  check-with-both-feeds:
    name: Check with GHSA and OSV Feeds
    uses: ./.github/workflows/reusable-check.yml
    with:
      use-ghsa: true
      use-osv: true
      fail-on-vulnerabilities: false

  # Example 8: Check with built-in GHSA + custom source
  check-with-ghsa-and-custom:
    name: Check with GHSA and Custom Source
    uses: ./.github/workflows/reusable-check.yml
    with:
      use-ghsa: true
      source: "https://raw.githubusercontent.com/maxgfr/package-checker.sh/main/test-fixtures/test-vulnerabilities.json"
      fail-on-vulnerabilities: false

  # Example 9: Check with built-in feeds + multiple custom sources
  check-with-feeds-and-sources:
    name: Check with Feeds and Multiple Sources
    uses: ./.github/workflows/reusable-check.yml
    with:
      use-ghsa: true
      use-osv: true
      sources: |
        https://raw.githubusercontent.com/maxgfr/package-checker.sh/main/test-fixtures/test-vulnerabilities.json
        https://raw.githubusercontent.com/maxgfr/package-checker.sh/main/test-fixtures/test-vulnerabilities.csv
      fail-on-vulnerabilities: false