@techdocs/cli 1.8.8 → 1.8.9-next.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # @techdocs/cli
2
2
 
3
+ ## 1.8.9-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/plugin-techdocs-node@1.12.3-next.0
9
+ - @backstage/backend-common@0.21.7-next.0
10
+ - @backstage/catalog-model@1.4.5
11
+ - @backstage/cli-common@0.1.13
12
+ - @backstage/config@1.2.0
13
+
3
14
  ## 1.8.8
4
15
 
5
16
  ### Patch Changes
@@ -961,56 +961,6 @@
961
961
  "$schema": "http://json-schema.org/draft-07/schema#"
962
962
  }
963
963
  },
964
- {
965
- "path": "../../plugins/stackstorm/config.d.ts",
966
- "value": {
967
- "type": "object",
968
- "properties": {
969
- "stackstorm": {
970
- "type": "object",
971
- "properties": {
972
- "webUrl": {
973
- "description": "StackStorm Web UI url\nUsed in links to StackStorm web UI",
974
- "visibility": "frontend",
975
- "type": "string"
976
- }
977
- },
978
- "required": [
979
- "webUrl"
980
- ]
981
- }
982
- },
983
- "$schema": "http://json-schema.org/draft-07/schema#"
984
- }
985
- },
986
- {
987
- "path": "../../node_modules/@oriflame/backstage-plugin-score-card/config.d.ts",
988
- "value": {
989
- "type": "object",
990
- "properties": {
991
- "scorecards": {
992
- "description": "Extra configuration for score card plugin",
993
- "type": "object",
994
- "properties": {
995
- "jsonDataUrl": {
996
- "description": "The public absolute root URL with json file defining the score card entries.",
997
- "visibility": "frontend",
998
- "type": "string"
999
- },
1000
- "wikiLinkTemplate": {
1001
- "description": "The template for the link to the wiki, e.g. \"https://TBD/XXX/_wiki/wikis/XXX.wiki/{id}\"",
1002
- "visibility": "frontend",
1003
- "type": "string"
1004
- }
1005
- }
1006
- }
1007
- },
1008
- "required": [
1009
- "scorecards"
1010
- ],
1011
- "$schema": "http://json-schema.org/draft-07/schema#"
1012
- }
1013
- },
1014
964
  {
1015
965
  "path": "../backend-common/config.d.ts",
1016
966
  "value": {
@@ -1426,47 +1376,52 @@
1426
1376
  }
1427
1377
  },
1428
1378
  {
1429
- "path": "../../node_modules/@oriflame/backstage-plugin-score-card/node_modules/@backstage/core-components/config.d.ts",
1379
+ "path": "../../plugins/stackstorm/config.d.ts",
1430
1380
  "value": {
1431
1381
  "type": "object",
1432
1382
  "properties": {
1433
- "auth": {
1383
+ "stackstorm": {
1434
1384
  "type": "object",
1435
1385
  "properties": {
1436
- "autologout": {
1437
- "description": "Autologout feature configuration",
1438
- "type": "object",
1439
- "properties": {
1440
- "enabled": {
1441
- "description": "Enable or disable the autologout feature",
1442
- "visibility": "frontend",
1443
- "type": "boolean"
1444
- },
1445
- "idleTimeoutMinutes": {
1446
- "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
1447
- "visibility": "frontend",
1448
- "type": "number"
1449
- },
1450
- "promptBeforeIdleSeconds": {
1451
- "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
1452
- "visibility": "frontend",
1453
- "type": "number"
1454
- },
1455
- "useWorkerTimers": {
1456
- "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
1457
- "visibility": "frontend",
1458
- "type": "boolean"
1459
- },
1460
- "logoutIfDisconnected": {
1461
- "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
1462
- "visibility": "frontend",
1463
- "type": "boolean"
1464
- }
1465
- }
1386
+ "webUrl": {
1387
+ "description": "StackStorm Web UI url\nUsed in links to StackStorm web UI",
1388
+ "visibility": "frontend",
1389
+ "type": "string"
1390
+ }
1391
+ },
1392
+ "required": [
1393
+ "webUrl"
1394
+ ]
1395
+ }
1396
+ },
1397
+ "$schema": "http://json-schema.org/draft-07/schema#"
1398
+ }
1399
+ },
1400
+ {
1401
+ "path": "../../node_modules/@oriflame/backstage-plugin-score-card/config.d.ts",
1402
+ "value": {
1403
+ "type": "object",
1404
+ "properties": {
1405
+ "scorecards": {
1406
+ "description": "Extra configuration for score card plugin",
1407
+ "type": "object",
1408
+ "properties": {
1409
+ "jsonDataUrl": {
1410
+ "description": "The public absolute root URL with json file defining the score card entries.",
1411
+ "visibility": "frontend",
1412
+ "type": "string"
1413
+ },
1414
+ "wikiLinkTemplate": {
1415
+ "description": "The template for the link to the wiki, e.g. \"https://TBD/XXX/_wiki/wikis/XXX.wiki/{id}\"",
1416
+ "visibility": "frontend",
1417
+ "type": "string"
1466
1418
  }
1467
1419
  }
1468
1420
  }
1469
1421
  },
1422
+ "required": [
1423
+ "scorecards"
1424
+ ],
1470
1425
  "$schema": "http://json-schema.org/draft-07/schema#"
1471
1426
  }
1472
1427
  },
@@ -1653,6 +1608,508 @@
1653
1608
  },
1654
1609
  "$schema": "http://json-schema.org/draft-07/schema#"
1655
1610
  }
1611
+ },
1612
+ {
1613
+ "path": "../../node_modules/@oriflame/backstage-plugin-score-card/node_modules/@backstage/core-components/config.d.ts",
1614
+ "value": {
1615
+ "type": "object",
1616
+ "properties": {
1617
+ "auth": {
1618
+ "type": "object",
1619
+ "properties": {
1620
+ "autologout": {
1621
+ "description": "Autologout feature configuration",
1622
+ "type": "object",
1623
+ "properties": {
1624
+ "enabled": {
1625
+ "description": "Enable or disable the autologout feature",
1626
+ "visibility": "frontend",
1627
+ "type": "boolean"
1628
+ },
1629
+ "idleTimeoutMinutes": {
1630
+ "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
1631
+ "visibility": "frontend",
1632
+ "type": "number"
1633
+ },
1634
+ "promptBeforeIdleSeconds": {
1635
+ "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
1636
+ "visibility": "frontend",
1637
+ "type": "number"
1638
+ },
1639
+ "useWorkerTimers": {
1640
+ "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
1641
+ "visibility": "frontend",
1642
+ "type": "boolean"
1643
+ },
1644
+ "logoutIfDisconnected": {
1645
+ "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
1646
+ "visibility": "frontend",
1647
+ "type": "boolean"
1648
+ }
1649
+ }
1650
+ }
1651
+ }
1652
+ }
1653
+ },
1654
+ "$schema": "http://json-schema.org/draft-07/schema#"
1655
+ }
1656
+ },
1657
+ {
1658
+ "path": "../../node_modules/@oriflame/backstage-plugin-score-card/node_modules/@backstage/plugin-catalog-react/node_modules/@backstage/core-components/config.d.ts",
1659
+ "value": {
1660
+ "type": "object",
1661
+ "properties": {
1662
+ "auth": {
1663
+ "type": "object",
1664
+ "properties": {
1665
+ "autologout": {
1666
+ "description": "Autologout feature configuration",
1667
+ "type": "object",
1668
+ "properties": {
1669
+ "enabled": {
1670
+ "description": "Enable or disable the autologout feature",
1671
+ "visibility": "frontend",
1672
+ "type": "boolean"
1673
+ },
1674
+ "idleTimeoutMinutes": {
1675
+ "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
1676
+ "visibility": "frontend",
1677
+ "type": "number"
1678
+ },
1679
+ "promptBeforeIdleSeconds": {
1680
+ "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
1681
+ "visibility": "frontend",
1682
+ "type": "number"
1683
+ },
1684
+ "useWorkerTimers": {
1685
+ "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
1686
+ "visibility": "frontend",
1687
+ "type": "boolean"
1688
+ },
1689
+ "logoutIfDisconnected": {
1690
+ "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
1691
+ "visibility": "frontend",
1692
+ "type": "boolean"
1693
+ }
1694
+ }
1695
+ }
1696
+ }
1697
+ }
1698
+ },
1699
+ "$schema": "http://json-schema.org/draft-07/schema#"
1700
+ }
1701
+ },
1702
+ {
1703
+ "path": "../../node_modules/@oriflame/backstage-plugin-score-card/node_modules/@backstage/integration/config.d.ts",
1704
+ "value": {
1705
+ "type": "object",
1706
+ "properties": {
1707
+ "integrations": {
1708
+ "description": "Configuration for integrations towards various external repository provider systems",
1709
+ "visibility": "frontend",
1710
+ "type": "object",
1711
+ "properties": {
1712
+ "azure": {
1713
+ "description": "Integration configuration for Azure",
1714
+ "type": "array",
1715
+ "items": {
1716
+ "type": "object",
1717
+ "properties": {
1718
+ "host": {
1719
+ "description": "The hostname of the given Azure instance",
1720
+ "visibility": "frontend",
1721
+ "type": "string"
1722
+ },
1723
+ "token": {
1724
+ "description": "Token used to authenticate requests.",
1725
+ "visibility": "secret",
1726
+ "deprecated": "Use `credentials` instead.",
1727
+ "type": "string"
1728
+ },
1729
+ "credential": {
1730
+ "description": "The credential to use for requests.\n\nIf no credential is specified anonymous access is used.",
1731
+ "deepVisibility": "secret",
1732
+ "deprecated": "Use `credentials` instead.",
1733
+ "type": "object",
1734
+ "properties": {
1735
+ "clientId": {
1736
+ "type": "string"
1737
+ },
1738
+ "clientSecret": {
1739
+ "type": "string"
1740
+ },
1741
+ "tenantId": {
1742
+ "type": "string"
1743
+ },
1744
+ "personalAccessToken": {
1745
+ "type": "string"
1746
+ }
1747
+ }
1748
+ },
1749
+ "credentials": {
1750
+ "description": "The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used.\nIf not organization matches the first credential without an organization is used.\n\nIf no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used.",
1751
+ "deepVisibility": "secret",
1752
+ "type": "array",
1753
+ "items": {
1754
+ "type": "object",
1755
+ "properties": {
1756
+ "clientId": {
1757
+ "type": "string"
1758
+ },
1759
+ "clientSecret": {
1760
+ "type": "string"
1761
+ },
1762
+ "tenantId": {
1763
+ "type": "string"
1764
+ },
1765
+ "personalAccessToken": {
1766
+ "type": "string"
1767
+ }
1768
+ }
1769
+ }
1770
+ }
1771
+ },
1772
+ "required": [
1773
+ "host"
1774
+ ]
1775
+ }
1776
+ },
1777
+ "bitbucket": {
1778
+ "description": "Integration configuration for Bitbucket",
1779
+ "deprecated": "replaced by bitbucketCloud and bitbucketServer",
1780
+ "type": "array",
1781
+ "items": {
1782
+ "type": "object",
1783
+ "properties": {
1784
+ "host": {
1785
+ "description": "The hostname of the given Bitbucket instance",
1786
+ "visibility": "frontend",
1787
+ "type": "string"
1788
+ },
1789
+ "token": {
1790
+ "description": "Token used to authenticate requests.",
1791
+ "visibility": "secret",
1792
+ "type": "string"
1793
+ },
1794
+ "apiBaseUrl": {
1795
+ "description": "The base url for the Bitbucket API, for example https://api.bitbucket.org/2.0",
1796
+ "visibility": "frontend",
1797
+ "type": "string"
1798
+ },
1799
+ "username": {
1800
+ "description": "The username to use for authenticated requests.",
1801
+ "visibility": "secret",
1802
+ "type": "string"
1803
+ },
1804
+ "appPassword": {
1805
+ "description": "Bitbucket app password used to authenticate requests.",
1806
+ "visibility": "secret",
1807
+ "type": "string"
1808
+ }
1809
+ },
1810
+ "required": [
1811
+ "host"
1812
+ ]
1813
+ }
1814
+ },
1815
+ "bitbucketCloud": {
1816
+ "description": "Integration configuration for Bitbucket Cloud",
1817
+ "type": "array",
1818
+ "items": {
1819
+ "type": "object",
1820
+ "properties": {
1821
+ "username": {
1822
+ "description": "The username to use for authenticated requests.",
1823
+ "visibility": "secret",
1824
+ "type": "string"
1825
+ },
1826
+ "appPassword": {
1827
+ "description": "Bitbucket Cloud app password used to authenticate requests.",
1828
+ "visibility": "secret",
1829
+ "type": "string"
1830
+ }
1831
+ },
1832
+ "required": [
1833
+ "appPassword",
1834
+ "username"
1835
+ ]
1836
+ }
1837
+ },
1838
+ "bitbucketServer": {
1839
+ "description": "Integration configuration for Bitbucket Server",
1840
+ "type": "array",
1841
+ "items": {
1842
+ "type": "object",
1843
+ "properties": {
1844
+ "host": {
1845
+ "description": "The hostname of the given Bitbucket Server instance",
1846
+ "visibility": "frontend",
1847
+ "type": "string"
1848
+ },
1849
+ "token": {
1850
+ "description": "Token used to authenticate requests.",
1851
+ "visibility": "secret",
1852
+ "type": "string"
1853
+ },
1854
+ "username": {
1855
+ "description": "Username used to authenticate requests with Basic Auth.",
1856
+ "visibility": "secret",
1857
+ "type": "string"
1858
+ },
1859
+ "password": {
1860
+ "description": "Password (or token as password) used to authenticate requests with Basic Auth.",
1861
+ "visibility": "secret",
1862
+ "type": "string"
1863
+ },
1864
+ "apiBaseUrl": {
1865
+ "description": "The base url for the Bitbucket Server API, for example https://<host>/rest/api/1.0",
1866
+ "visibility": "frontend",
1867
+ "type": "string"
1868
+ }
1869
+ },
1870
+ "required": [
1871
+ "host"
1872
+ ]
1873
+ }
1874
+ },
1875
+ "gerrit": {
1876
+ "description": "Integration configuration for Gerrit",
1877
+ "type": "array",
1878
+ "items": {
1879
+ "type": "object",
1880
+ "properties": {
1881
+ "host": {
1882
+ "description": "The hostname of the given Gerrit instance",
1883
+ "visibility": "frontend",
1884
+ "type": "string"
1885
+ },
1886
+ "baseUrl": {
1887
+ "description": "The base url for the Gerrit instance.",
1888
+ "visibility": "frontend",
1889
+ "type": "string"
1890
+ },
1891
+ "cloneUrl": {
1892
+ "description": "The base url for cloning repos.",
1893
+ "visibility": "frontend",
1894
+ "type": "string"
1895
+ },
1896
+ "username": {
1897
+ "description": "The username to use for authenticated requests.",
1898
+ "visibility": "secret",
1899
+ "type": "string"
1900
+ },
1901
+ "password": {
1902
+ "description": "Gerrit password used to authenticate requests. This can be either a password\nor a generated access token.",
1903
+ "visibility": "secret",
1904
+ "type": "string"
1905
+ }
1906
+ },
1907
+ "required": [
1908
+ "host"
1909
+ ]
1910
+ }
1911
+ },
1912
+ "github": {
1913
+ "description": "Integration configuration for GitHub",
1914
+ "type": "array",
1915
+ "items": {
1916
+ "type": "object",
1917
+ "properties": {
1918
+ "host": {
1919
+ "description": "The hostname of the given GitHub instance",
1920
+ "visibility": "frontend",
1921
+ "type": "string"
1922
+ },
1923
+ "token": {
1924
+ "description": "Token used to authenticate requests.",
1925
+ "visibility": "secret",
1926
+ "type": "string"
1927
+ },
1928
+ "apiBaseUrl": {
1929
+ "description": "The base url for the GitHub API, for example https://api.github.com",
1930
+ "visibility": "frontend",
1931
+ "type": "string"
1932
+ },
1933
+ "rawBaseUrl": {
1934
+ "description": "The base url for GitHub raw resources, for example https://raw.githubusercontent.com",
1935
+ "visibility": "frontend",
1936
+ "type": "string"
1937
+ },
1938
+ "apps": {
1939
+ "description": "GitHub Apps configuration",
1940
+ "type": "array",
1941
+ "items": {
1942
+ "type": "object",
1943
+ "properties": {
1944
+ "appId": {
1945
+ "description": "The numeric GitHub App ID, string for environment variables",
1946
+ "type": [
1947
+ "string",
1948
+ "number"
1949
+ ]
1950
+ },
1951
+ "privateKey": {
1952
+ "description": "The private key to use for auth against the app",
1953
+ "visibility": "secret",
1954
+ "type": "string"
1955
+ },
1956
+ "webhookSecret": {
1957
+ "description": "The secret used for webhooks",
1958
+ "visibility": "secret",
1959
+ "type": "string"
1960
+ },
1961
+ "clientId": {
1962
+ "description": "The client ID to use",
1963
+ "type": "string"
1964
+ },
1965
+ "clientSecret": {
1966
+ "description": "The client secret to use",
1967
+ "visibility": "secret",
1968
+ "type": "string"
1969
+ },
1970
+ "allowedInstallationOwners": {
1971
+ "description": "List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.\nHowever you can list the installations with the GitHub API. You can find the list of installations here:\nhttps://api.github.com/app/installations\nThe relevant documentation for this is here.\nhttps://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples",
1972
+ "type": "array",
1973
+ "items": {
1974
+ "type": "string"
1975
+ }
1976
+ }
1977
+ },
1978
+ "required": [
1979
+ "appId",
1980
+ "clientId",
1981
+ "clientSecret",
1982
+ "privateKey",
1983
+ "webhookSecret"
1984
+ ]
1985
+ }
1986
+ }
1987
+ },
1988
+ "required": [
1989
+ "host"
1990
+ ]
1991
+ }
1992
+ },
1993
+ "gitlab": {
1994
+ "description": "Integration configuration for GitLab",
1995
+ "type": "array",
1996
+ "items": {
1997
+ "type": "object",
1998
+ "properties": {
1999
+ "host": {
2000
+ "description": "The host of the target that this matches on, e.g. \"gitlab.com\".",
2001
+ "visibility": "frontend",
2002
+ "type": "string"
2003
+ },
2004
+ "apiBaseUrl": {
2005
+ "description": "The base URL of the API of this provider, e.g.\n\"https://gitlab.com/api/v4\", with no trailing slash.\n\nMay be omitted specifically for public GitLab; then it will be deduced.",
2006
+ "visibility": "frontend",
2007
+ "type": "string"
2008
+ },
2009
+ "token": {
2010
+ "description": "The authorization token to use for requests to this provider.\n\nIf no token is specified, anonymous access is used.",
2011
+ "visibility": "secret",
2012
+ "type": "string"
2013
+ },
2014
+ "baseUrl": {
2015
+ "description": "The baseUrl of this provider, e.g. \"https://gitlab.com\", which is\npassed into the GitLab client.\n\nIf no baseUrl is provided, it will default to https://${host}.",
2016
+ "visibility": "frontend",
2017
+ "type": "string"
2018
+ }
2019
+ },
2020
+ "required": [
2021
+ "host"
2022
+ ]
2023
+ }
2024
+ },
2025
+ "googleGcs": {
2026
+ "description": "Integration configuration for Google Cloud Storage",
2027
+ "type": "object",
2028
+ "properties": {
2029
+ "clientEmail": {
2030
+ "description": "Service account email used to authenticate requests.",
2031
+ "type": "string"
2032
+ },
2033
+ "privateKey": {
2034
+ "description": "Service account private key used to authenticate requests.",
2035
+ "visibility": "secret",
2036
+ "type": "string"
2037
+ }
2038
+ }
2039
+ },
2040
+ "awsS3": {
2041
+ "description": "Integration configuration for AWS S3 Service",
2042
+ "type": "array",
2043
+ "items": {
2044
+ "type": "object",
2045
+ "properties": {
2046
+ "endpoint": {
2047
+ "description": "AWS Endpoint.\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.",
2048
+ "visibility": "frontend",
2049
+ "type": "string"
2050
+ },
2051
+ "s3ForcePathStyle": {
2052
+ "description": "Whether to use path style URLs when communicating with S3.\nDefaults to false.\nThis allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.",
2053
+ "visibility": "frontend",
2054
+ "type": "boolean"
2055
+ },
2056
+ "accessKeyId": {
2057
+ "description": "Account access key used to authenticate requests.",
2058
+ "type": "string"
2059
+ },
2060
+ "secretAccessKey": {
2061
+ "description": "Account secret key used to authenticate requests.",
2062
+ "visibility": "secret",
2063
+ "type": "string"
2064
+ },
2065
+ "roleArn": {
2066
+ "description": "ARN of the role to be assumed",
2067
+ "type": "string"
2068
+ },
2069
+ "externalId": {
2070
+ "description": "External ID to use when assuming role",
2071
+ "type": "string"
2072
+ }
2073
+ }
2074
+ }
2075
+ },
2076
+ "gitea": {
2077
+ "description": "Integration configuration for Gitea",
2078
+ "type": "array",
2079
+ "items": {
2080
+ "type": "object",
2081
+ "properties": {
2082
+ "host": {
2083
+ "description": "The hostname of the given Gitea instance",
2084
+ "visibility": "frontend",
2085
+ "type": "string"
2086
+ },
2087
+ "baseUrl": {
2088
+ "description": "The base url for the Gitea instance.",
2089
+ "visibility": "frontend",
2090
+ "type": "string"
2091
+ },
2092
+ "username": {
2093
+ "description": "The username to use for authenticated requests.",
2094
+ "visibility": "secret",
2095
+ "type": "string"
2096
+ },
2097
+ "password": {
2098
+ "description": "Gitea password used to authenticate requests. This can be either a password\nor a generated access token.",
2099
+ "visibility": "secret",
2100
+ "type": "string"
2101
+ }
2102
+ },
2103
+ "required": [
2104
+ "host"
2105
+ ]
2106
+ }
2107
+ }
2108
+ }
2109
+ }
2110
+ },
2111
+ "$schema": "http://json-schema.org/draft-07/schema#"
2112
+ }
1656
2113
  }
1657
2114
  ],
1658
2115
  "backstageConfigSchemaVersion": 1