docs(changeset): add option to force use Twine credentials for publis…

…hing to PyPI
konfig-dev · Oct 30, 2023 · 8c03fa0 · 8c03fa0
1 parent 94fc6dd
commit 8c03fa0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/generator/konfig-dash/.changeset/lemon-tables-yell.md b/generator/konfig-dash/.changeset/lemon-tables-yell.md
@@ -0,0 +1,5 @@
+---
+'konfig-cli': minor
+---
+
+add option to force use Twine credentials for publishing to PyPI
diff --git a/generator/konfig-dash/packages/konfig-cli/src/commands/publish.ts b/generator/konfig-dash/packages/konfig-cli/src/commands/publish.ts
@@ -256,15 +256,18 @@ const publishScripts = {
     version,
     gitlabRepositoryId,
     skipTag,
+    useTwine,
   }: {
     test?: boolean
     token?: string
     version: string
     gitlabRepositoryId?: string
     skipTag?: boolean
+    useTwine?: boolean
   }) => {
     const repository = test ? '-r testpypi ' : ''
-    const credentials = token !== undefined ? `-u __token__ -p ${token} ` : ''
+    const credentials =
+      token !== undefined && !useTwine ? `-u __token__ -p ${token} ` : ''
     const gitTagCommands = generateGitTagCommands({
       version,
       generator: 'python',
@@ -323,6 +326,11 @@ export default class Publish extends Command {
       description: 'Specify all generators',
       exclusive: ['generator'],
     }),
+    useTwine: Flags.boolean({
+      name: 'twine',
+      char: 'T',
+      description: 'Force use TWINE_USERNAME and TWINE_PASSWORD for publishing',
+    }),
     test: Flags.boolean({ name: 'test', char: 't' }),
     skipRemoteCheck: Flags.boolean({
       name: 'skipRemoteCheck',
@@ -557,7 +565,8 @@ export default class Publish extends Command {
       ) {
         const pythonConfig = python.parse(generatorConfig)
         const usesToken =
-          pythonConfig.pypiApiTokenEnvironmentVariable !== undefined
+          pythonConfig.pypiApiTokenEnvironmentVariable !== undefined &&
+          !flags.useTwine
         const testPyPI = flags.test || pythonConfig.testPyPI
         if (testPyPI && !usesToken) {
           if (!process.env.TEST_TWINE_USERNAME)
@@ -588,7 +597,6 @@ export default class Publish extends Command {
           throw Error(
             `Set ${pythonConfig.pypiApiTokenEnvironmentVariable} environment variable to publish to PyPI`
           )
-
         if (pythonConfig.gitlabRepositoryId !== undefined) {
           if (!process.env.GITLAB_USERNAME)
             CliUx.ux.error(
@@ -603,6 +611,7 @@ export default class Publish extends Command {
           script: publishScripts['pypi']({
             test: !!testPyPI,
             token,
+            useTwine: flags.useTwine,
             version: pythonConfig.version,
             gitlabRepositoryId: pythonConfig.gitlabRepositoryId,
             skipTag: flags.skipTag,