github2snipe/2snipe.json at main · jackvaughanjr/github2snipe · 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
{
  "$schema": "https://raw.githubusercontent.com/jackvaughanjr/2snipe-manager/main/2snipe.schema.json",
  "name": "github2snipe",
  "display_name": "GitHub",
  "description": "Sync GitHub Enterprise or organization members to Snipe-IT license seats",
  "version": "1.6.0",
  "min_snipemgr": "0.1.0",
  "tags": ["saas", "developer-tools", "vcs"],
  "category": "Developer Tools & Hosting",
  "config_schema": [
    {
      "key": "github.mode",
      "label": "Connection Mode",
      "secret": false,
      "required": true,
      "default": "enterprise",
      "hint": "\"enterprise\" to sync all members of a GitHub Enterprise; \"organization\" to sync a single org"
    },
    {
      "key": "github.enterprise",
      "label": "GitHub Enterprise Slug",
      "secret": false,
      "required": false,
      "hint": "Required when mode: enterprise. URL slug from github.com/enterprises/<slug>"
    },
    {
      "key": "github.organization",
      "label": "GitHub Organization Name",
      "secret": false,
      "required": false,
      "hint": "Required when mode: organization. The org's login name (not display name)"
    },
    {
      "key": "github.token",
      "label": "GitHub Personal Access Token",
      "secret": true,
      "required": true,
      "hint": "enterprise mode: admin:enterprise scope. organization mode: read:org scope"
    },
    {
      "key": "snipe_it.url",
      "label": "Snipe-IT URL",
      "secret": false,
      "required": true,
      "hint": "e.g. https://snipe.example.com"
    },
    {
      "key": "snipe_it.api_key",
      "label": "Snipe-IT API Key",
      "secret": true,
      "required": true,
      "hint": "Admin → API Keys in your Snipe-IT instance"
    },
    {
      "key": "snipe_it.license_category_id",
      "label": "Snipe-IT License Category ID",
      "secret": false,
      "required": true,
      "hint": "Find at Admin → Categories (integer ID)"
    },
    {
      "key": "snipe_it.license_name",
      "label": "Snipe-IT License Name Override",
      "secret": false,
      "required": false,
      "hint": "Optional. Overrides the auto-resolved name (\"GitHub Enterprise\" or \"GitHub\")"
    },
    {
      "key": "github.license_name_prefix",
      "label": "License Name Prefix",
      "secret": false,
      "required": false,
      "hint": "Optional prefix prepended to the license name, e.g. \"Acme - \""
    },
    {
      "key": "github.license_name_suffix",
      "label": "License Name Suffix",
      "secret": false,
      "required": false,
      "hint": "Optional suffix appended to the license name, e.g. \" (acme)\""
    },
    {
      "key": "github.include_outside_collaborators",
      "label": "Include Outside Collaborators",
      "secret": false,
      "required": false,
      "default": "false",
      "hint": "Sync outside collaborators (organization mode only)"
    },
    {
      "key": "github.include_pending_invitations",
      "label": "Include Pending Invitations",
      "secret": false,
      "required": false,
      "default": "false",
      "hint": "Sync pending membership invitations (organization mode only)"
    },
    {
      "key": "slack.webhook_url",
      "label": "Slack Webhook URL",
      "secret": true,
      "required": false,
      "hint": "Optional. Incoming webhook for sync notifications"
    }
  ],
  "shared_config": ["snipe_it"],
  "commands": {
    "sync": true,
    "test": true
  },
  "releases": {
    "github_releases": true,
    "asset_pattern": "github2snipe-{os}-{arch}"
  }
}