nsip 0.4.0

NSIP Search API client for nsipsearch.nsip.org/api
Documentation 
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

---
name: ADR Validation

"on":
  pull_request:
    paths:
      - 'docs/adr/**'
  push:
    branches: [main, master]
    paths:
      - 'docs/adr/**'
  workflow_dispatch:

permissions:
  contents: read
  pull-requests: write

jobs:
  validate:
    name: Validate ADRs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        # v6.0.2
        # v6.0.2
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

      - name: Validate ADR Format
        # main
        uses: zircote/adrscope@15b8b2658badb6ee22bc1cac797dcb503dd0c2a5
        with:
          command: validate
          input-dir: docs/adr
          pattern: "[0-9]*.md"

      - name: Get ADR Statistics
        # main
        uses: zircote/adrscope@15b8b2658badb6ee22bc1cac797dcb503dd0c2a5
        with:
          command: stats
          input-dir: docs/adr

      - name: Comment on PR
        if: github.event_name == 'pull_request'
        # v7.0.1
        uses: >-
          actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd
        with:
          script: |
            const fs = require('fs');
            const statsFile = 'adr-stats.json';

            if (!fs.existsSync(statsFile)) {
              console.log('No stats file generated');
              return;
            }

            const stats = JSON.parse(fs.readFileSync(statsFile, 'utf8'));

            const comment = `## ADR Validation Results

            📊 **Statistics:**
            - Total ADRs: ${stats.total || 0}
            - Accepted: ${stats.accepted || 0}
            - Proposed: ${stats.proposed || 0}
            - Deprecated: ${stats.deprecated || 0}
            - Superseded: ${stats.superseded || 0}

            ✅ All ADRs validated successfully!`;

            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: comment
            });