cake-build/cake

TFBuild.IsRunningOnVSTS is confusing when using own build agent

Open

#1,580 opened on Apr 23, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C# (3,742 stars) (738 forks)batch import
Help wantedImprovementUp-for-grabs

Description

What You Are Seeing?

I have a VSTS build agent, which is triggering a cake build on GitHub commits.

I tried using the TFBuild.IsRunningOnVSTS to check if this was a build running on VSTS, as I am also using AppVeyor.

What is Expected?

I would have expected TFBuild.IsRunningOnVSTS to return true. It returned false.

This seems to be per design as seen in the TFBuildProvider

What version of Cake are you using?

Latest

I discussed this briefly with @patriksvensson on Gitter and we kind of agreed that the IsRunningOnVSTS and IsRunningOnTFS properties could be a bit misleading.

@patriksvensson suggested a possible rename:

IsRunningOnVSTS -> IsRunningOnSharedAgent IsRunningOnTFS -> IsRunningOnOwnAgent

To me this would be much more clear as VSTS can both run shared and own agents.

@agc93 you seem to be the original author of this feature, what do you think about this?

Contributor guide

Tech stack
csharp
Domain
build system
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C#Cake build systemTFBuild provider
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the TFBuildProvider.cs file at src/Cake.Common/Build/TFBuild/TFBuildProvider.cs to understand the current IsRunningOnVSTS and IsRunningOnTFS properties. Analyze all usages across the codebase. Propose a rename to IsRunningOnSharedAgent and IsRunningOnOwnAgent, ensuring backward compatibility. Engage with maintainers @patriksvensson and @agc93 to finalize the new names and implementation.