Disable telemetry

[Shatur]

Could you add an option to disable telemetry?
Maybe should be enabled by default? I don't think Microsoft needs statistics on vcpkg from GitHub Actions.

[lukka]

@Shatur95 yes, that makes sense. I think by creating environment variable VCPKG_DISABLE_METRICS, the telemetry would be disabled, e.g.:

uses: lukka/run-vcpkg@v4
with:
   ....
env:
   VCPKG_DISABLE_METRICS: 1

If this works, all i need is to add this information to the documentation.

[Shatur]

Oh, yes, this will work :)

[Shatur]

With manifest mode it should be added to cmake runs.

@lukka, could we just pass -disableMetrics to bootstrap-vcpkg script by default?

[lukka]

@Shatur yes, the action could just define the VCPKG_DISABLE_METRICS env var.

For now, this is achievable like this for run-cmake:

uses: lukka/run-cmake@v10
with:
   ....
env:
   VCPKG_DISABLE_METRICS: 1

Question: How would users be able to opt-in if the action always define that env var?
I'm thinking about minimizing changes, i.e. finding a solution that does not employ adding new inputs and much business logic.
Input is welcome :)

[Shatur]

Question: How would users be able to opt-in if the action always define that env var?

Is there a user who wants to enable telemetry for CI? I don't think so :)

I'm thinking about minimizing changes, i.e. finding a solution that does not employ adding new inputs and much business logic.

Totally understand. I would just pass -disableMetrics to bootstrap-vcpkg. It will disable the telemetry permanently.

[lukka]

Probably this would be a simple one liner solution that allow the user to opt-in, but defaults to opt-out:

if (!process.env['VCPKG_ENABLE_METRICS']) process.env['VCPKG_DISABLE_METRICS'] = "1";

[Shatur]

Sounds reasonable!

[Shatur]

On the other hand, an option would be more intuitive for the user.
But I don't think anyone will need this opt-out. Is there at least one use-case for telemetry enabled on CI?

[lukka]

Fixed in #126 , please try run-vcpkg@v10.1 and let me know!