Should we suggest pinning of virtual environments in CI builds

[nils-a]

In light of recent "pin you're Cake version" discussions after the 1.0.0 release:

Should we suggest to pin to a specific virtual environment?

I.e. currently

• Azure Pipelines docs suggest using windows-latest
• GitHub Actions docs suggest using windows-latest, ubuntu-latest and macos-latest

/cc @gep13 , @AdmiringWorm

[AdmiringWorm]

TBH, I am not completely sure if we would want to have the example use a specific virtual environment.
What I think could be done though, is to have a notice on the documentation that there are more specific environments that can be used and link to the documentation that lists those environments.

GitHub Actions list those environments here: https://docs.github.com/en/actions/reference/specifications-for-github-hosted-runners
and here: https://github.com/actions/virtual-environments/blob/main/README.md

No idea about Azure though.

[nils-a]

Azure docs are here: https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops&tabs=yaml#software

I'll see if I can add a reference to the specific docs, along with a notice.

[AdmiringWorm]

I am going back on my previous comment, and I have changed my mind in regards to suggesting that we pin to a virtual image instead.

For GitHub action that would be the image ubuntu-18.04, and probably something similar on azure.
Mostly changed my mind due to the Draft release notes issue that was mentioned on Gary's stream today.

I still think it would be worthwhile to mention other images available, or linking to the official documentation of the available images.

[cake-contrib-bot]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

• GitHub Release
• NuGet Package

Your GitReleaseManager bot 📦🚀