artifactory.json 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. /**
  2. * This configuration file manages Rush integration with JFrog Artifactory services.
  3. * More documentation is available on the Rush website: https://rushjs.io
  4. */
  5. {
  6. "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/artifactory.schema.json",
  7. "packageRegistry": {
  8. /**
  9. * (Required) Set this to "true" to enable Rush to manage tokens for an Artifactory NPM registry.
  10. * When enabled, "rush install" will automatically detect when the user's ~/.npmrc
  11. * authentication token is missing or expired. And "rush setup" will prompt the user to
  12. * renew their token.
  13. *
  14. * The default value is false.
  15. */
  16. "enabled": false,
  17. /**
  18. * (Required) Specify the URL of your NPM registry. This is the same URL that appears in
  19. * your .npmrc file. It should look something like this example:
  20. *
  21. * https://your-company.jfrog.io/your-project/api/npm/npm-private/
  22. */
  23. "registryUrl": "",
  24. /**
  25. * A list of custom strings that "rush setup" should add to the user's ~/.npmrc file at the time
  26. * when the token is updated. This could be used for example to configure the company registry
  27. * to be used whenever NPM is invoked as a standalone command (but it's not needed for Rush
  28. * operations like "rush add" and "rush install", which get their mappings from the monorepo's
  29. * common/config/rush/.npmrc file).
  30. *
  31. * NOTE: The ~/.npmrc settings are global for the user account on a given machine, so be careful
  32. * about adding settings that may interfere with other work outside the monorepo.
  33. */
  34. "userNpmrcLinesToAdd": [
  35. // "@example:registry=https://your-company.jfrog.io/your-project/api/npm/npm-private/"
  36. ],
  37. /**
  38. * (Required) Specifies the URL of the Artifactory control panel where the user can generate
  39. * an API key. This URL is printed after the "visitWebsite" message.
  40. * It should look something like this example: https://your-company.jfrog.io/
  41. * Specify an empty string to suppress this line entirely.
  42. */
  43. "artifactoryWebsiteUrl": "",
  44. /**
  45. * Uncomment this line to specify the type of credential to save in the user's ~/.npmrc file.
  46. * The default is "password", which means the user's API token will be traded in for an
  47. * npm password specific to that registry. Optionally you can specify "authToken", which
  48. * will save the user's API token as credentials instead.
  49. */
  50. // "credentialType": "password",
  51. /**
  52. * These settings allow the "rush setup" interactive prompts to be customized, for
  53. * example with messages specific to your team or configuration. Specify an empty string
  54. * to suppress that message entirely.
  55. */
  56. "messageOverrides": {
  57. /**
  58. * Overrides the message that normally says:
  59. * "This monorepo consumes packages from an Artifactory private NPM registry."
  60. */
  61. // "introduction": "",
  62. /**
  63. * Overrides the message that normally says:
  64. * "Please contact the repository maintainers for help with setting up an Artifactory user account."
  65. */
  66. // "obtainAnAccount": "",
  67. /**
  68. * Overrides the message that normally says:
  69. * "Please open this URL in your web browser:"
  70. *
  71. * The "artifactoryWebsiteUrl" string is printed after this message.
  72. */
  73. // "visitWebsite": "",
  74. /**
  75. * Overrides the message that normally says:
  76. * "Your user name appears in the upper-right corner of the JFrog website."
  77. */
  78. // "locateUserName": "",
  79. /**
  80. * Overrides the message that normally says:
  81. * "Click 'Edit Profile' on the JFrog website. Click the 'Generate API Key'
  82. * button if you haven't already done so previously."
  83. */
  84. // "locateApiKey": ""
  85. /**
  86. * Overrides the message that normally prompts:
  87. * "What is your Artifactory user name?"
  88. */
  89. // "userNamePrompt": ""
  90. /**
  91. * Overrides the message that normally prompts:
  92. * "What is your Artifactory API key?"
  93. */
  94. // "apiKeyPrompt": ""
  95. }
  96. }
  97. }