@backstage/plugin-scaffolder-backend-module-github 0.4.1-next.1 → 0.4.1-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs.js CHANGED
@@ -942,6 +942,912 @@ const examples$8 = [
942
942
  }
943
943
  ]
944
944
  })
945
+ },
946
+ {
947
+ description: "Set repository homepage.",
948
+ example: yaml__default.default.stringify({
949
+ steps: [
950
+ {
951
+ action: "github:repo:create",
952
+ name: "Create a new GitHub repository with homepage",
953
+ input: {
954
+ repoUrl: "github.com?repo=repo&owner=owner",
955
+ homepage: "https://example.com"
956
+ }
957
+ }
958
+ ]
959
+ })
960
+ },
961
+ {
962
+ description: "Create a private repository.",
963
+ example: yaml__default.default.stringify({
964
+ steps: [
965
+ {
966
+ action: "github:repo:create",
967
+ name: "Create a new private GitHub repository",
968
+ input: {
969
+ repoUrl: "github.com?repo=repo&owner=owner",
970
+ repoVisibility: "private"
971
+ }
972
+ }
973
+ ]
974
+ })
975
+ },
976
+ {
977
+ description: "Enable required code owner reviews.",
978
+ example: yaml__default.default.stringify({
979
+ steps: [
980
+ {
981
+ action: "github:repo:create",
982
+ name: "Create a new GitHub repository with required code owner reviews",
983
+ input: {
984
+ repoUrl: "github.com?repo=repo&owner=owner",
985
+ requireCodeOwnerReviews: true
986
+ }
987
+ }
988
+ ]
989
+ })
990
+ },
991
+ {
992
+ description: "Set required approving review count to 2.",
993
+ example: yaml__default.default.stringify({
994
+ steps: [
995
+ {
996
+ action: "github:repo:create",
997
+ name: "Create a new GitHub repository with required approving review count",
998
+ input: {
999
+ repoUrl: "github.com?repo=repo&owner=owner",
1000
+ requiredApprovingReviewCount: 2
1001
+ }
1002
+ }
1003
+ ]
1004
+ })
1005
+ },
1006
+ {
1007
+ description: "Allow squash merge only.",
1008
+ example: yaml__default.default.stringify({
1009
+ steps: [
1010
+ {
1011
+ action: "github:repo:create",
1012
+ name: "Create a new GitHub repository allowing only squash merge",
1013
+ input: {
1014
+ repoUrl: "github.com?repo=repo&owner=owner",
1015
+ allowMergeCommit: false,
1016
+ allowSquashMerge: true,
1017
+ allowRebaseMerge: false
1018
+ }
1019
+ }
1020
+ ]
1021
+ })
1022
+ },
1023
+ {
1024
+ description: "Set squash merge commit title to pull request title.",
1025
+ example: yaml__default.default.stringify({
1026
+ steps: [
1027
+ {
1028
+ action: "github:repo:create",
1029
+ name: "Create a new GitHub repository with squash merge commit title set to pull request title",
1030
+ input: {
1031
+ repoUrl: "github.com?repo=repo&owner=owner",
1032
+ squashMergeCommitTitle: "pull_request_title"
1033
+ }
1034
+ }
1035
+ ]
1036
+ })
1037
+ },
1038
+ {
1039
+ description: "Set squash merge commit message to blank.",
1040
+ example: yaml__default.default.stringify({
1041
+ steps: [
1042
+ {
1043
+ action: "github:repo:create",
1044
+ name: "Create a new GitHub repository with squash merge commit message set to blank",
1045
+ input: {
1046
+ repoUrl: "github.com?repo=repo&owner=owner",
1047
+ squashMergeCommitMessage: "blank"
1048
+ }
1049
+ }
1050
+ ]
1051
+ })
1052
+ },
1053
+ {
1054
+ description: "Allow auto-merge.",
1055
+ example: yaml__default.default.stringify({
1056
+ steps: [
1057
+ {
1058
+ action: "github:repo:create",
1059
+ name: "Create a new GitHub repository allowing auto-merge",
1060
+ input: {
1061
+ repoUrl: "github.com?repo=repo&owner=owner",
1062
+ allowAutoMerge: true
1063
+ }
1064
+ }
1065
+ ]
1066
+ })
1067
+ },
1068
+ {
1069
+ description: "Set collaborators with push access.",
1070
+ example: yaml__default.default.stringify({
1071
+ steps: [
1072
+ {
1073
+ action: "github:repo:create",
1074
+ name: "Create a new GitHub repository with collaborators having push access",
1075
+ input: {
1076
+ repoUrl: "github.com?repo=repo&owner=owner",
1077
+ collaborators: [
1078
+ { username: "user1", permission: "push" },
1079
+ { username: "user2", permission: "push" }
1080
+ ]
1081
+ }
1082
+ }
1083
+ ]
1084
+ })
1085
+ },
1086
+ {
1087
+ description: "Add topics to repository.",
1088
+ example: yaml__default.default.stringify({
1089
+ steps: [
1090
+ {
1091
+ action: "github:repo:create",
1092
+ name: "Create a new GitHub repository with topics",
1093
+ input: {
1094
+ repoUrl: "github.com?repo=repo&owner=owner",
1095
+ topics: ["devops", "kubernetes", "ci-cd"]
1096
+ }
1097
+ }
1098
+ ]
1099
+ })
1100
+ },
1101
+ {
1102
+ description: "Add secret variables to repository.",
1103
+ example: yaml__default.default.stringify({
1104
+ steps: [
1105
+ {
1106
+ action: "github:repo:create",
1107
+ name: "Create a new GitHub repository with secret variables",
1108
+ input: {
1109
+ repoUrl: "github.com?repo=repo&owner=owner",
1110
+ secrets: [
1111
+ { name: "SECRET_KEY", value: "supersecretkey" },
1112
+ { name: "API_TOKEN", value: "tokenvalue" }
1113
+ ]
1114
+ }
1115
+ }
1116
+ ]
1117
+ })
1118
+ },
1119
+ {
1120
+ description: "Enable branch protection requiring status checks.",
1121
+ example: yaml__default.default.stringify({
1122
+ steps: [
1123
+ {
1124
+ action: "github:repo:create",
1125
+ name: "Create a new GitHub repository with branch protection requiring status checks",
1126
+ input: {
1127
+ repoUrl: "github.com?repo=repo&owner=owner",
1128
+ requiredStatusCheckContexts: ["ci/circleci: build"]
1129
+ }
1130
+ }
1131
+ ]
1132
+ })
1133
+ },
1134
+ {
1135
+ description: "Require branches to be up-to-date before merging.",
1136
+ example: yaml__default.default.stringify({
1137
+ steps: [
1138
+ {
1139
+ action: "github:repo:create",
1140
+ name: "Create a new GitHub repository requiring branches to be up-to-date before merging",
1141
+ input: {
1142
+ repoUrl: "github.com?repo=repo&owner=owner",
1143
+ requireBranchesToBeUpToDate: true
1144
+ }
1145
+ }
1146
+ ]
1147
+ })
1148
+ },
1149
+ {
1150
+ description: "Require conversation resolution before merging.",
1151
+ example: yaml__default.default.stringify({
1152
+ steps: [
1153
+ {
1154
+ action: "github:repo:create",
1155
+ name: "Create a new GitHub repository requiring conversation resolution before merging",
1156
+ input: {
1157
+ repoUrl: "github.com?repo=repo&owner=owner",
1158
+ requiredConversationResolution: true
1159
+ }
1160
+ }
1161
+ ]
1162
+ })
1163
+ },
1164
+ {
1165
+ description: "Delete branch on merge.",
1166
+ example: yaml__default.default.stringify({
1167
+ steps: [
1168
+ {
1169
+ action: "github:repo:create",
1170
+ name: "Create a new GitHub repository with branch deletion on merge",
1171
+ input: {
1172
+ repoUrl: "github.com?repo=repo&owner=owner",
1173
+ deleteBranchOnMerge: true
1174
+ }
1175
+ }
1176
+ ]
1177
+ })
1178
+ },
1179
+ {
1180
+ description: "Customize OIDC token.",
1181
+ example: yaml__default.default.stringify({
1182
+ steps: [
1183
+ {
1184
+ action: "github:repo:create",
1185
+ name: "Create a new GitHub repository with OIDC token customization",
1186
+ input: {
1187
+ repoUrl: "github.com?repo=repo&owner=owner",
1188
+ oidcCustomization: {
1189
+ sub: "repo:owner/repo",
1190
+ aud: "https://github.com"
1191
+ }
1192
+ }
1193
+ }
1194
+ ]
1195
+ })
1196
+ },
1197
+ {
1198
+ description: "Require commit signing.",
1199
+ example: yaml__default.default.stringify({
1200
+ steps: [
1201
+ {
1202
+ action: "github:repo:create",
1203
+ name: "Create a new GitHub repository requiring commit signing",
1204
+ input: {
1205
+ repoUrl: "github.com?repo=repo&owner=owner",
1206
+ requiredCommitSigning: true
1207
+ }
1208
+ }
1209
+ ]
1210
+ })
1211
+ },
1212
+ {
1213
+ description: "Set multiple properties including description, homepage, and visibility.",
1214
+ example: yaml__default.default.stringify({
1215
+ steps: [
1216
+ {
1217
+ action: "github:repo:create",
1218
+ name: "Create a new GitHub repository with multiple properties",
1219
+ input: {
1220
+ repoUrl: "github.com?repo=repo&owner=owner",
1221
+ description: "A repository for project XYZ",
1222
+ homepage: "https://project-xyz.com",
1223
+ repoVisibility: "internal"
1224
+ }
1225
+ }
1226
+ ]
1227
+ })
1228
+ },
1229
+ {
1230
+ description: "Configure branch protection with multiple settings.",
1231
+ example: yaml__default.default.stringify({
1232
+ steps: [
1233
+ {
1234
+ action: "github:repo:create",
1235
+ name: "Create a new GitHub repository with branch protection settings",
1236
+ input: {
1237
+ repoUrl: "github.com?repo=repo&owner=owner",
1238
+ requiredStatusCheckContexts: [
1239
+ "ci/circleci: build",
1240
+ "ci/circleci: test"
1241
+ ],
1242
+ requireBranchesToBeUpToDate: true,
1243
+ requiredConversationResolution: true,
1244
+ requiredApprovingReviewCount: 2
1245
+ }
1246
+ }
1247
+ ]
1248
+ })
1249
+ },
1250
+ {
1251
+ description: "Set repository access to private and add collaborators with admin access.",
1252
+ example: yaml__default.default.stringify({
1253
+ steps: [
1254
+ {
1255
+ action: "github:repo:create",
1256
+ name: "Create a new private GitHub repository with collaborators",
1257
+ input: {
1258
+ repoUrl: "github.com?repo=repo&owner=owner",
1259
+ repoVisibility: "private",
1260
+ collaborators: [
1261
+ { username: "admin1", permission: "admin" },
1262
+ { username: "admin2", permission: "admin" }
1263
+ ]
1264
+ }
1265
+ }
1266
+ ]
1267
+ })
1268
+ },
1269
+ {
1270
+ description: "Enable GitHub Projects for the repository.",
1271
+ example: yaml__default.default.stringify({
1272
+ steps: [
1273
+ {
1274
+ action: "github:repo:create",
1275
+ name: "Create a new GitHub repository with GitHub Projects enabled",
1276
+ input: {
1277
+ repoUrl: "github.com?repo=repo&owner=owner",
1278
+ hasProjects: true
1279
+ }
1280
+ }
1281
+ ]
1282
+ })
1283
+ },
1284
+ {
1285
+ description: "Disable merge commits and allow only rebase and squash merges.",
1286
+ example: yaml__default.default.stringify({
1287
+ steps: [
1288
+ {
1289
+ action: "github:repo:create",
1290
+ name: "Create a new GitHub repository allowing only rebase and squash merges",
1291
+ input: {
1292
+ repoUrl: "github.com?repo=repo&owner=owner",
1293
+ allowMergeCommit: false,
1294
+ allowRebaseMerge: true,
1295
+ allowSquashMerge: true
1296
+ }
1297
+ }
1298
+ ]
1299
+ })
1300
+ },
1301
+ {
1302
+ description: "Set repository access to internal with no projects and issues.",
1303
+ example: yaml__default.default.stringify({
1304
+ steps: [
1305
+ {
1306
+ action: "github:repo:create",
1307
+ name: "Create a new internal GitHub repository without projects and issues",
1308
+ input: {
1309
+ repoUrl: "github.com?repo=repo&owner=owner",
1310
+ repoVisibility: "internal",
1311
+ hasProjects: false,
1312
+ hasIssues: false
1313
+ }
1314
+ }
1315
+ ]
1316
+ })
1317
+ },
1318
+ {
1319
+ description: "Create repository with OIDC customization for specific audience.",
1320
+ example: yaml__default.default.stringify({
1321
+ steps: [
1322
+ {
1323
+ action: "github:repo:create",
1324
+ name: "Create a new GitHub repository with OIDC customization for specific audience",
1325
+ input: {
1326
+ repoUrl: "github.com?repo=repo&owner=owner",
1327
+ oidcCustomization: {
1328
+ sub: "repo:owner/repo",
1329
+ aud: "https://specific-audience.com"
1330
+ }
1331
+ }
1332
+ }
1333
+ ]
1334
+ })
1335
+ },
1336
+ {
1337
+ description: "Require all branches to be up-to-date before merging.",
1338
+ example: yaml__default.default.stringify({
1339
+ steps: [
1340
+ {
1341
+ action: "github:repo:create",
1342
+ name: "Create a new GitHub repository requiring all branches to be up-to-date",
1343
+ input: {
1344
+ repoUrl: "github.com?repo=repo&owner=owner",
1345
+ requireBranchesToBeUpToDate: true
1346
+ }
1347
+ }
1348
+ ]
1349
+ })
1350
+ },
1351
+ {
1352
+ description: "Set description and topics for the repository.",
1353
+ example: yaml__default.default.stringify({
1354
+ steps: [
1355
+ {
1356
+ action: "github:repo:create",
1357
+ name: "Create a new GitHub repository with description and topics",
1358
+ input: {
1359
+ repoUrl: "github.com?repo=repo&owner=owner",
1360
+ description: "Repository for project ABC",
1361
+ topics: ["python", "machine-learning", "data-science"]
1362
+ }
1363
+ }
1364
+ ]
1365
+ })
1366
+ },
1367
+ {
1368
+ description: "Set repository visibility to public and enable commit signing.",
1369
+ example: yaml__default.default.stringify({
1370
+ steps: [
1371
+ {
1372
+ action: "github:repo:create",
1373
+ name: "Create a new public GitHub repository with commit signing required",
1374
+ input: {
1375
+ repoUrl: "github.com?repo=repo&owner=owner",
1376
+ repoVisibility: "public",
1377
+ requiredCommitSigning: true
1378
+ }
1379
+ }
1380
+ ]
1381
+ })
1382
+ },
1383
+ {
1384
+ description: "Create a repository with collaborators and default branch protection.",
1385
+ example: yaml__default.default.stringify({
1386
+ steps: [
1387
+ {
1388
+ action: "github:repo:create",
1389
+ name: "Create a new GitHub repository with collaborators and branch protection",
1390
+ input: {
1391
+ repoUrl: "github.com?repo=repo&owner=owner",
1392
+ collaborators: [
1393
+ { username: "contributor1", permission: "write" },
1394
+ { username: "contributor2", permission: "write" }
1395
+ ],
1396
+ requiredStatusCheckContexts: ["ci/travis: build"]
1397
+ }
1398
+ }
1399
+ ]
1400
+ })
1401
+ },
1402
+ {
1403
+ description: "Add multiple secret variables.",
1404
+ example: yaml__default.default.stringify({
1405
+ steps: [
1406
+ {
1407
+ action: "github:repo:create",
1408
+ name: "Create a new GitHub repository with multiple secret variables",
1409
+ input: {
1410
+ repoUrl: "github.com?repo=repo&owner=owner",
1411
+ secrets: [
1412
+ { name: "SECRET_KEY_1", value: "value1" },
1413
+ { name: "SECRET_KEY_2", value: "value2" }
1414
+ ]
1415
+ }
1416
+ }
1417
+ ]
1418
+ })
1419
+ },
1420
+ {
1421
+ description: "Require a minimum of 2 approving reviews for merging.",
1422
+ example: yaml__default.default.stringify({
1423
+ steps: [
1424
+ {
1425
+ action: "github:repo:create",
1426
+ name: "Create a new GitHub repository with 2 required approving reviews",
1427
+ input: {
1428
+ repoUrl: "github.com?repo=repo&owner=owner",
1429
+ requiredApprovingReviewCount: 2
1430
+ }
1431
+ }
1432
+ ]
1433
+ })
1434
+ },
1435
+ {
1436
+ description: "Enable branch protection with conversation resolution required.",
1437
+ example: yaml__default.default.stringify({
1438
+ steps: [
1439
+ {
1440
+ action: "github:repo:create",
1441
+ name: "Create a new GitHub repository with branch protection and conversation resolution required",
1442
+ input: {
1443
+ repoUrl: "github.com?repo=repo&owner=owner",
1444
+ requiredConversationResolution: true
1445
+ }
1446
+ }
1447
+ ]
1448
+ })
1449
+ },
1450
+ {
1451
+ description: "Set repository visibility to internal with description and homepage.",
1452
+ example: yaml__default.default.stringify({
1453
+ steps: [
1454
+ {
1455
+ action: "github:repo:create",
1456
+ name: "Create a new internal GitHub repository with description and homepage",
1457
+ input: {
1458
+ repoUrl: "github.com?repo=repo&owner=owner",
1459
+ repoVisibility: "internal",
1460
+ description: "Internal repository for team collaboration",
1461
+ homepage: "https://internal.example.com"
1462
+ }
1463
+ }
1464
+ ]
1465
+ })
1466
+ },
1467
+ {
1468
+ description: "Disable auto-merge.",
1469
+ example: yaml__default.default.stringify({
1470
+ steps: [
1471
+ {
1472
+ action: "github:repo:create",
1473
+ name: "Create a new GitHub repository with auto-merge disabled",
1474
+ input: {
1475
+ repoUrl: "github.com?repo=repo&owner=owner",
1476
+ allowAutoMerge: false
1477
+ }
1478
+ }
1479
+ ]
1480
+ })
1481
+ },
1482
+ {
1483
+ description: "Set repository topics and enable GitHub Projects.",
1484
+ example: yaml__default.default.stringify({
1485
+ steps: [
1486
+ {
1487
+ action: "github:repo:create",
1488
+ name: "Create a new GitHub repository with topics and GitHub Projects enabled",
1489
+ input: {
1490
+ repoUrl: "github.com?repo=repo&owner=owner",
1491
+ topics: ["opensource", "nodejs", "api"],
1492
+ hasProjects: true
1493
+ }
1494
+ }
1495
+ ]
1496
+ })
1497
+ },
1498
+ {
1499
+ description: "Create a private repository with collaborators having admin and write access.",
1500
+ example: yaml__default.default.stringify({
1501
+ steps: [
1502
+ {
1503
+ action: "github:repo:create",
1504
+ name: "Create a new private GitHub repository with multiple collaborators",
1505
+ input: {
1506
+ repoUrl: "github.com?repo=repo&owner=owner",
1507
+ repoVisibility: "private",
1508
+ collaborators: [
1509
+ { username: "admin1", permission: "admin" },
1510
+ { username: "writer1", permission: "write" }
1511
+ ]
1512
+ }
1513
+ }
1514
+ ]
1515
+ })
1516
+ },
1517
+ {
1518
+ description: "Disable branch deletion on merge.",
1519
+ example: yaml__default.default.stringify({
1520
+ steps: [
1521
+ {
1522
+ action: "github:repo:create",
1523
+ name: "Create a new GitHub repository with branch deletion on merge disabled",
1524
+ input: {
1525
+ repoUrl: "github.com?repo=repo&owner=owner",
1526
+ deleteBranchOnMerge: false
1527
+ }
1528
+ }
1529
+ ]
1530
+ })
1531
+ },
1532
+ {
1533
+ description: "Set repository visibility to internal and enable commit signing.",
1534
+ example: yaml__default.default.stringify({
1535
+ steps: [
1536
+ {
1537
+ action: "github:repo:create",
1538
+ name: "Create a new internal GitHub repository with commit signing required",
1539
+ input: {
1540
+ repoUrl: "github.com?repo=repo&owner=owner",
1541
+ repoVisibility: "internal",
1542
+ requiredCommitSigning: true
1543
+ }
1544
+ }
1545
+ ]
1546
+ })
1547
+ },
1548
+ {
1549
+ description: "Create repository with description, homepage, and required status checks.",
1550
+ example: yaml__default.default.stringify({
1551
+ steps: [
1552
+ {
1553
+ action: "github:repo:create",
1554
+ name: "Create a new GitHub repository with description, homepage, and status checks",
1555
+ input: {
1556
+ repoUrl: "github.com?repo=repo&owner=owner",
1557
+ description: "Repository for web application project",
1558
+ homepage: "https://webapp.example.com",
1559
+ requiredStatusCheckContexts: [
1560
+ "ci/travis: build",
1561
+ "ci/travis: lint"
1562
+ ]
1563
+ }
1564
+ }
1565
+ ]
1566
+ })
1567
+ },
1568
+ {
1569
+ description: "Enable squash merges only and set commit message to pull request description.",
1570
+ example: yaml__default.default.stringify({
1571
+ steps: [
1572
+ {
1573
+ action: "github:repo:create",
1574
+ name: "Create a new GitHub repository allowing only squash merges with commit message set to pull request description",
1575
+ input: {
1576
+ repoUrl: "github.com?repo=repo&owner=owner",
1577
+ allowMergeCommit: false,
1578
+ allowSquashMerge: true,
1579
+ allowRebaseMerge: false,
1580
+ squashMergeCommitMessage: "pull_request_description"
1581
+ }
1582
+ }
1583
+ ]
1584
+ })
1585
+ },
1586
+ {
1587
+ description: "Enable rebase merges only and require commit signing.",
1588
+ example: yaml__default.default.stringify({
1589
+ steps: [
1590
+ {
1591
+ action: "github:repo:create",
1592
+ name: "Create a new GitHub repository allowing only rebase merges with commit signing required",
1593
+ input: {
1594
+ repoUrl: "github.com?repo=repo&owner=owner",
1595
+ allowMergeCommit: false,
1596
+ allowRebaseMerge: true,
1597
+ allowSquashMerge: false,
1598
+ requiredCommitSigning: true
1599
+ }
1600
+ }
1601
+ ]
1602
+ })
1603
+ },
1604
+ {
1605
+ description: "Create repository with OIDC customization for multiple audiences.",
1606
+ example: yaml__default.default.stringify({
1607
+ steps: [
1608
+ {
1609
+ action: "github:repo:create",
1610
+ name: "Create a new GitHub repository with OIDC customization for multiple audiences",
1611
+ input: {
1612
+ repoUrl: "github.com?repo=repo&owner=owner",
1613
+ oidcCustomization: {
1614
+ sub: "repo:owner/repo",
1615
+ aud: ["https://audience1.com", "https://audience2.com"]
1616
+ }
1617
+ }
1618
+ }
1619
+ ]
1620
+ })
1621
+ },
1622
+ {
1623
+ description: "Enable branch protection with required approving reviews and status checks.",
1624
+ example: yaml__default.default.stringify({
1625
+ steps: [
1626
+ {
1627
+ action: "github:repo:create",
1628
+ name: "Create a new GitHub repository with branch protection requiring approving reviews and status checks",
1629
+ input: {
1630
+ repoUrl: "github.com?repo=repo&owner=owner",
1631
+ requiredApprovingReviewCount: 2,
1632
+ requiredStatusCheckContexts: [
1633
+ "ci/circleci: build",
1634
+ "ci/circleci: test"
1635
+ ]
1636
+ }
1637
+ }
1638
+ ]
1639
+ })
1640
+ },
1641
+ {
1642
+ description: "Create a public repository with topics and secret variables.",
1643
+ example: yaml__default.default.stringify({
1644
+ steps: [
1645
+ {
1646
+ action: "github:repo:create",
1647
+ name: "Create a new public GitHub repository with topics and secret variables",
1648
+ input: {
1649
+ repoUrl: "github.com?repo=repo&owner=owner",
1650
+ repoVisibility: "public",
1651
+ topics: ["javascript", "react", "frontend"],
1652
+ secrets: [
1653
+ { name: "API_KEY", value: "apikeyvalue" },
1654
+ { name: "DB_PASSWORD", value: "dbpasswordvalue" }
1655
+ ]
1656
+ }
1657
+ }
1658
+ ]
1659
+ })
1660
+ },
1661
+ {
1662
+ description: "Set repository description and disable issues and wiki.",
1663
+ example: yaml__default.default.stringify({
1664
+ steps: [
1665
+ {
1666
+ action: "github:repo:create",
1667
+ name: "Create a new GitHub repository with description, and disable issues and wiki",
1668
+ input: {
1669
+ repoUrl: "github.com?repo=repo&owner=owner",
1670
+ description: "Repository for backend service",
1671
+ hasIssues: false,
1672
+ hasWiki: false
1673
+ }
1674
+ }
1675
+ ]
1676
+ })
1677
+ },
1678
+ {
1679
+ description: "Enable required conversation resolution and commit signing.",
1680
+ example: yaml__default.default.stringify({
1681
+ steps: [
1682
+ {
1683
+ action: "github:repo:create",
1684
+ name: "Create a new GitHub repository with required conversation resolution and commit signing",
1685
+ input: {
1686
+ repoUrl: "github.com?repo=repo&owner=owner",
1687
+ requiredConversationResolution: true,
1688
+ requiredCommitSigning: true
1689
+ }
1690
+ }
1691
+ ]
1692
+ })
1693
+ },
1694
+ {
1695
+ description: "Set repository visibility to private and require branches to be up-to-date.",
1696
+ example: yaml__default.default.stringify({
1697
+ steps: [
1698
+ {
1699
+ action: "github:repo:create",
1700
+ name: "Create a new private GitHub repository requiring branches to be up-to-date",
1701
+ input: {
1702
+ repoUrl: "github.com?repo=repo&owner=owner",
1703
+ repoVisibility: "private",
1704
+ requireBranchesToBeUpToDate: true
1705
+ }
1706
+ }
1707
+ ]
1708
+ })
1709
+ },
1710
+ {
1711
+ description: "Create a repository with default settings and add multiple topics.",
1712
+ example: yaml__default.default.stringify({
1713
+ steps: [
1714
+ {
1715
+ action: "github:repo:create",
1716
+ name: "Create a new GitHub repository with default settings and topics",
1717
+ input: {
1718
+ repoUrl: "github.com?repo=repo&owner=owner",
1719
+ topics: ["devops", "ci-cd", "automation"]
1720
+ }
1721
+ }
1722
+ ]
1723
+ })
1724
+ },
1725
+ {
1726
+ description: "Disable merge commits, enable auto-merge, and require commit signing.",
1727
+ example: yaml__default.default.stringify({
1728
+ steps: [
1729
+ {
1730
+ action: "github:repo:create",
1731
+ name: "Create a new GitHub repository disabling merge commits, enabling auto-merge, and requiring commit signing",
1732
+ input: {
1733
+ repoUrl: "github.com?repo=repo&owner=owner",
1734
+ allowMergeCommit: false,
1735
+ allowAutoMerge: true,
1736
+ requiredCommitSigning: true
1737
+ }
1738
+ }
1739
+ ]
1740
+ })
1741
+ },
1742
+ {
1743
+ description: "Create a repository with homepage, collaborators, and topics.",
1744
+ example: yaml__default.default.stringify({
1745
+ steps: [
1746
+ {
1747
+ action: "github:repo:create",
1748
+ name: "Create a new GitHub repository with homepage, collaborators, and topics",
1749
+ input: {
1750
+ repoUrl: "github.com?repo=repo&owner=owner",
1751
+ homepage: "https://example.com",
1752
+ collaborators: [
1753
+ { username: "user1", permission: "push" },
1754
+ { username: "user2", permission: "admin" }
1755
+ ],
1756
+ topics: ["opensource", "contribution"]
1757
+ }
1758
+ }
1759
+ ]
1760
+ })
1761
+ },
1762
+ {
1763
+ description: "Create a repository with branch protection and description.",
1764
+ example: yaml__default.default.stringify({
1765
+ steps: [
1766
+ {
1767
+ action: "github:repo:create",
1768
+ name: "Create a new GitHub repository with branch protection and description",
1769
+ input: {
1770
+ repoUrl: "github.com?repo=repo&owner=owner",
1771
+ requiredStatusCheckContexts: ["ci/travis: build"],
1772
+ requiredApprovingReviewCount: 1,
1773
+ description: "Repository for microservice development"
1774
+ }
1775
+ }
1776
+ ]
1777
+ })
1778
+ },
1779
+ {
1780
+ description: "Create a repository with OIDC customization and topics.",
1781
+ example: yaml__default.default.stringify({
1782
+ steps: [
1783
+ {
1784
+ action: "github:repo:create",
1785
+ name: "Create a new GitHub repository with OIDC customization and topics",
1786
+ input: {
1787
+ repoUrl: "github.com?repo=repo&owner=owner",
1788
+ oidcCustomization: {
1789
+ sub: "repo:owner/repo",
1790
+ aud: "https://api.example.com"
1791
+ },
1792
+ topics: ["api", "security"]
1793
+ }
1794
+ }
1795
+ ]
1796
+ })
1797
+ },
1798
+ {
1799
+ description: "Enable required code owner reviews and branch deletion on merge.",
1800
+ example: yaml__default.default.stringify({
1801
+ steps: [
1802
+ {
1803
+ action: "github:repo:create",
1804
+ name: "Create a new GitHub repository with required code owner reviews and branch deletion on merge",
1805
+ input: {
1806
+ repoUrl: "github.com?repo=repo&owner=owner",
1807
+ requireCodeOwnerReviews: true,
1808
+ deleteBranchOnMerge: true
1809
+ }
1810
+ }
1811
+ ]
1812
+ })
1813
+ },
1814
+ {
1815
+ description: "Create a repository with multiple secret variables and collaborators.",
1816
+ example: yaml__default.default.stringify({
1817
+ steps: [
1818
+ {
1819
+ action: "github:repo:create",
1820
+ name: "Create a new GitHub repository with multiple secret variables and collaborators",
1821
+ input: {
1822
+ repoUrl: "github.com?repo=repo&owner=owner",
1823
+ secrets: [
1824
+ { name: "API_SECRET", value: "secretvalue" },
1825
+ { name: "DB_USER", value: "dbuser" }
1826
+ ],
1827
+ collaborators: [
1828
+ { username: "dev1", permission: "write" },
1829
+ { username: "dev2", permission: "push" }
1830
+ ]
1831
+ }
1832
+ }
1833
+ ]
1834
+ })
1835
+ },
1836
+ {
1837
+ description: "Enable branch protection requiring status checks and conversation resolution.",
1838
+ example: yaml__default.default.stringify({
1839
+ steps: [
1840
+ {
1841
+ action: "github:repo:create",
1842
+ name: "Create a new GitHub repository with branch protection requiring status checks and conversation resolution",
1843
+ input: {
1844
+ repoUrl: "github.com?repo=repo&owner=owner",
1845
+ requiredStatusCheckContexts: ["ci/build"],
1846
+ requiredConversationResolution: true
1847
+ }
1848
+ }
1849
+ ]
1850
+ })
945
1851
  }
946
1852
  ];
947
1853
 
@@ -2926,6 +3832,198 @@ const examples = [
2926
3832
  }
2927
3833
  ]
2928
3834
  })
3835
+ },
3836
+ {
3837
+ description: "Enables GitHub Pages for a repository with a custom source path.",
3838
+ example: yaml__default.default.stringify({
3839
+ steps: [
3840
+ {
3841
+ action: "github:pages",
3842
+ id: "github-pages-custom-path",
3843
+ name: "Enable GitHub Pages with Custom Source Path",
3844
+ input: {
3845
+ repoUrl: "github.com?repo=customPathRepo&owner=customOwner",
3846
+ sourcePath: "/docs",
3847
+ token: "gph_YourGitHubToken"
3848
+ }
3849
+ }
3850
+ ]
3851
+ })
3852
+ },
3853
+ {
3854
+ description: "Enables GitHub Pages for a repository using legacy build type.",
3855
+ example: yaml__default.default.stringify({
3856
+ steps: [
3857
+ {
3858
+ action: "github:pages",
3859
+ id: "github-pages-legacy",
3860
+ name: "Enable GitHub Pages with Legacy Build Type",
3861
+ input: {
3862
+ repoUrl: "github.com?repo=legacyRepo&owner=legacyOwner",
3863
+ buildType: "legacy",
3864
+ token: "gph_YourGitHubToken"
3865
+ }
3866
+ }
3867
+ ]
3868
+ })
3869
+ },
3870
+ {
3871
+ description: "Enables GitHub Pages for a repository with a custom source branch.",
3872
+ example: yaml__default.default.stringify({
3873
+ steps: [
3874
+ {
3875
+ action: "github:pages",
3876
+ id: "github-pages-custom-branch",
3877
+ name: "Enable GitHub Pages with Custom Source Branch",
3878
+ input: {
3879
+ repoUrl: "github.com?repo=customBranchRepo&owner=branchOwner",
3880
+ sourceBranch: "develop",
3881
+ token: "gph_YourGitHubToken"
3882
+ }
3883
+ }
3884
+ ]
3885
+ })
3886
+ },
3887
+ {
3888
+ description: "Enables GitHub Pages for a repository with full customization.",
3889
+ example: yaml__default.default.stringify({
3890
+ steps: [
3891
+ {
3892
+ action: "github:pages",
3893
+ id: "github-pages-full-custom",
3894
+ name: "Enable GitHub Pages with Full Customization",
3895
+ input: {
3896
+ repoUrl: "github.com?repo=fullCustomRepo&owner=customOwner",
3897
+ buildType: "workflow",
3898
+ sourceBranch: "main",
3899
+ sourcePath: "/docs",
3900
+ token: "gph_YourGitHubToken"
3901
+ }
3902
+ }
3903
+ ]
3904
+ })
3905
+ },
3906
+ {
3907
+ description: "Enables GitHub Pages for a repository with minimal configuration.",
3908
+ example: yaml__default.default.stringify({
3909
+ steps: [
3910
+ {
3911
+ action: "github:pages",
3912
+ id: "github-pages-minimal",
3913
+ name: "Enable GitHub Pages with Minimal Configuration",
3914
+ input: {
3915
+ repoUrl: "github.com?repo=minimalRepo&owner=minimalOwner",
3916
+ token: "gph_YourGitHubToken"
3917
+ }
3918
+ }
3919
+ ]
3920
+ })
3921
+ },
3922
+ {
3923
+ description: "Enables GitHub Pages for a repository with custom build type and source path.",
3924
+ example: yaml__default.default.stringify({
3925
+ steps: [
3926
+ {
3927
+ action: "github:pages",
3928
+ id: "github-pages-custom-build-path",
3929
+ name: "Enable GitHub Pages with Custom Build Type and Source Path",
3930
+ input: {
3931
+ repoUrl: "github.com?repo=customBuildPathRepo&owner=customOwner",
3932
+ buildType: "legacy",
3933
+ sourcePath: "/custom-path",
3934
+ token: "gph_YourGitHubToken"
3935
+ }
3936
+ }
3937
+ ]
3938
+ })
3939
+ },
3940
+ {
3941
+ description: "Enables GitHub Pages for a repository with custom source branch and path.",
3942
+ example: yaml__default.default.stringify({
3943
+ steps: [
3944
+ {
3945
+ action: "github:pages",
3946
+ id: "github-pages-custom-branch-path",
3947
+ name: "Enable GitHub Pages with Custom Source Branch and Path",
3948
+ input: {
3949
+ repoUrl: "github.com?repo=customBranchPathRepo&owner=branchPathOwner",
3950
+ sourceBranch: "feature-branch",
3951
+ sourcePath: "/project-docs",
3952
+ token: "gph_YourGitHubToken"
3953
+ }
3954
+ }
3955
+ ]
3956
+ })
3957
+ },
3958
+ {
3959
+ description: "Enables GitHub Pages for a repository with a custom owner and repository name.",
3960
+ example: yaml__default.default.stringify({
3961
+ steps: [
3962
+ {
3963
+ action: "github:pages",
3964
+ id: "github-pages-custom-owner-repo",
3965
+ name: "Enable GitHub Pages with Custom Owner and Repository Name",
3966
+ input: {
3967
+ repoUrl: "github.com?repo=customRepoName&owner=customOwnerName",
3968
+ token: "gph_YourGitHubToken"
3969
+ }
3970
+ }
3971
+ ]
3972
+ })
3973
+ },
3974
+ {
3975
+ description: "Enables GitHub Pages for a repository with full customization and a different token.",
3976
+ example: yaml__default.default.stringify({
3977
+ steps: [
3978
+ {
3979
+ action: "github:pages",
3980
+ id: "github-pages-full-custom-diff-token",
3981
+ name: "Enable GitHub Pages with Full Customization and Different Token",
3982
+ input: {
3983
+ repoUrl: "github.com?repo=customTokenRepo&owner=tokenOwner",
3984
+ buildType: "workflow",
3985
+ sourceBranch: "main",
3986
+ sourcePath: "/site",
3987
+ token: "gph_DifferentGitHubToken"
3988
+ }
3989
+ }
3990
+ ]
3991
+ })
3992
+ },
3993
+ {
3994
+ description: "Enables GitHub Pages for a repository with a specific token for authorization.",
3995
+ example: yaml__default.default.stringify({
3996
+ steps: [
3997
+ {
3998
+ action: "github:pages",
3999
+ id: "github-pages-specific-token",
4000
+ name: "Enable GitHub Pages with Specific Token",
4001
+ input: {
4002
+ repoUrl: "github.com?repo=specificTokenRepo&owner=tokenOwner",
4003
+ token: "gph_SpecificGitHubToken"
4004
+ }
4005
+ }
4006
+ ]
4007
+ })
4008
+ },
4009
+ {
4010
+ description: "Enables GitHub Pages for a documentation site with custom configuration.",
4011
+ example: yaml__default.default.stringify({
4012
+ steps: [
4013
+ {
4014
+ action: "github:pages",
4015
+ id: "github-pages-doc-site",
4016
+ name: "Enable GitHub Pages for Documentation Site",
4017
+ input: {
4018
+ repoUrl: "github.com?repo=docSiteRepo&owner=docsOwner",
4019
+ buildType: "workflow",
4020
+ sourceBranch: "docs-branch",
4021
+ sourcePath: "/docs-site",
4022
+ token: "gph_DocsGitHubToken"
4023
+ }
4024
+ }
4025
+ ]
4026
+ })
2929
4027
  }
2930
4028
  ];
2931
4029