Merge pull request #22 from DilumAluthge/dpa/env

Add the optional `modify_environment` kwarg to the `authenticate(server::AbstractString)` method

Author: pfitzseb

src/PkgAuthentication.jl

@@ -32,14 +32,17 @@ function _assert_pkg_server_env_var_is_set()
 end
 
 """
-    authenticate(server::AbstractString)
+    authenticate(server::AbstractString; kwargs...)
 
 Starts interactive (blocking) browser-based Pkg server authentication for the Pkg
 server specified by `server`. Also sets the `$(pkg_server_env_var_name)` environment
 variable to `server`.
 
 `server` must be the URL of a valid Pkg server.
 
+## Keyword arguments
+- `modify_environment::Bool = true`: Set the `$(pkg_server_env_var_name)` environment variable to `server`. In package code, this should probably be set to `false`, so that the package would not have unexpected global side effects.
+
 ## Example usage
 
 ```julia
@@ -51,13 +54,20 @@ function authenticate(
     auth_suffix::Union{String, Nothing} = nothing,
     force::Union{Bool, Nothing} = nothing,
     tries::Union{Integer, Nothing} = nothing,
+    modify_environment::Bool = true,
 )::Union{Success, Failure}
-    ENV[pkg_server_env_var_name] = server
-    authenticate(;
-        auth_suffix = auth_suffix,
-        force = force,
-        tries = tries,
-    )
+    if modify_environment
+        ENV[pkg_server_env_var_name] = server
+    end
+    # Even if `modify_environment` is `false`, we still need to set the environment
+    # variable for the duration of the `authenticate` call.
+    withenv(pkg_server_env_var_name => server) do
+        authenticate(;
+            auth_suffix = auth_suffix,
+            force = force,
+            tries = tries,
+        )
+    end
 end
 
 """