fix: improve CI output

[mdonnalley]

• add onlyShowAtEndInCI config prop so that consumers can choose for information to only be shown at the very end when in CI
• Don't repeat stage headers when receiving updates to stage specific infos
• Reprint stage or stage specific infos after 5 minutes (configurable with OCLIF_CI_HEARTBEAT_FREQUENCY_MS or SF_CI_HEARTBEAT_FREQUENCY_MS)
• Throttle new information every 5 seconds (configurable with OCLIF_CI_UPDATE_FREQUENCY_MS or SF_CI_UPDATE_FREQUENCY_MS)

forcedotcom/cli#3079
@W-17060727@

[cristiand391]

QA notes:

setup:
tested a few via bin/run.js project deploy start on dreamhouse and the sf-specific deploy example in this repo (mostly to test the new features with bunch of updates on multiple stages).

✅ stage headers aren't duplicated on data updates
✅ can configure reprint stage info via SF_CI_HEARTBEAT_FREQUENCY_MS
✅ SF_CI_HEARTBEAT_FREQUENCY_MS lower than the deploy poll interval, I can see previous data being printed, if new data comes in the frequency is still respected
✅ SF_CI_UPDATE_FREQUENCY_MS throttles new info frequency, setting it to 10000 on a small deploy I only see the start and the finished update after 10s
✅ stages with onlyShowAtEndInCI are rendered at the end of stages when it finished.

[rasmuszimmer]

@cristiand391 we are trying to use SF_CI_HEARTBEAT_FREQUENCY_MS to slow down theoutput in our Azure Pipelines console. Do you have any pointers on how to set it? We tried just setting as env var but seemed to not have any effect..

[cristiand391]

@rasmuszimmer
setting it as an env var should work, are you setting the value to miliseconds? here's an example:
sf v2.65.8 (current stable release):

383990580-22d25d52-83eb-4171-9198-77e2b346b7b6.mov

NOTE
I'm setting CI=true manually to force CI output, Azure Pipelines or any other CI provider likely have CI env var set.

[avesolovksyy]

@cristiand391
From our practical experiments, to make it work in Azure DevOps, you really need to set CI=true explicitly.
Don't know about other CI providers.
Could you please mention CI=true in SFDX guide, in section with env variables described.
Thanks in advance.