Add input no-qt-binaries as a synonym for tools-only

ddalcino · ddalcino · commit 9307e28277dc · 2023-03-18T17:30:01.000-07:00
If a user wants to install source, docs, or examples, without installing
Qt binaries, then that user would have to turn on `tools-only`.
That option does not make semantic sense for these use cases, since the
user is not installing tools alone, and may not be installing tools at
all.

This change allows a user to turn off installation of Qt binaries using
an option that makes sense semantically.
diff --git a/README.md b/README.md
@@ -123,9 +123,17 @@ Set this to false if you want to avoid setting environment variables for whateve
 
 Default: `true`
 
+### `no-qt-binaries`
+
+Set this to true if you want to skip installing Qt. 
+This option is useful if you want to install tools, source, documentation, or examples.
+
+Default: `false`
+
 ### `tools-only`
 
-Set this to true if you only want to install tools, and not Qt.
+This is a synonym for `no-qt-binaries`. It only exists to preserve backwards compatibility.
+If you set either `no-qt-binaries` or `tools-only` to `true`, you will skip installation of Qt.
 
 Default: `false`
 
diff --git a/action/action.yml b/action/action.yml
@@ -39,8 +39,11 @@ inputs:
   set-env:
     default: true
     description: Whether or not to set environment variables after running aqtinstall
+  no-qt-binaries:
+    description: Turns off installation of Qt. Useful for installing tools, source, documentation, or examples.
+    default: false
   tools-only:
-    description: Whether or not to actually install Qt or just the tools from the tools argument
+    description: Synonym for `no-qt-binaries`, used for backwards compatibility.
     default: false
   aqtversion:
     description: Version of aqtinstall to use in case of issues
diff --git a/action/src/main.ts b/action/src/main.ts
@@ -68,7 +68,7 @@ class Inputs {
   readonly installDeps: boolean | "nosudo";
   readonly cache: boolean;
   readonly cacheKeyPrefix: string;
-  readonly toolsOnly: boolean;
+  readonly isInstallQtBinaries: boolean;
   readonly setEnv: boolean;
 
   readonly aqtVersion: string;
@@ -166,7 +166,8 @@ class Inputs {
 
     this.cacheKeyPrefix = core.getInput("cache-key-prefix");
 
-    this.toolsOnly = Inputs.getBoolInput("tools-only");
+    this.isInstallQtBinaries =
+      !Inputs.getBoolInput("tools-only") && !Inputs.getBoolInput("no-qt-binaries");
 
     this.setEnv = Inputs.getBoolInput("set-env");
 
@@ -288,7 +289,7 @@ const run = async (): Promise<void> => {
       ]);
 
       // Install Qt
-      if (!inputs.toolsOnly) {
+      if (inputs.isInstallQtBinaries) {
         const qtArgs = [inputs.host, inputs.target, inputs.version];
 
         if (inputs.arch) {
@@ -336,7 +337,7 @@ const run = async (): Promise<void> => {
       if (inputs.tools.length) {
         core.exportVariable("IQTA_TOOLS", nativePath(`${inputs.dir}/Tools`));
       }
-      if (!inputs.toolsOnly) {
+      if (inputs.isInstallQtBinaries) {
         const qtPath = nativePath(locateQtArchDir(inputs.dir));
         if (process.platform === "linux") {
           setOrAppendEnvVar("LD_LIBRARY_PATH", nativePath(`${qtPath}/lib`));
