"Migrating from GitLab CI/CD to GitHub Actions" article uses Gitlab CI_COMMIT_REF_SLUG without equivalent Github variable

[jeverling]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions#caching

What part(s) of the article would you like to see updated?

The article uses the following example for how to translate caching of workflow files:

image: node:latest

cache:
  key: $CI_COMMIT_REF_SLUG
  paths:
    - .npm/

There is no equivalent variable being shown for Github, instead the cache key is set to key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}.

I think it would be better to use an example, where there is actually an equivalent variable in Github.

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

@jeverling Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[lucascosti]

👋 @jeverling I'm not super familiar with GitLab CI/CD caching, but I think the GitLab example is shown that way because it's the recommended way of specifying the scope of a GitLab cache (i.e. to limit the cache access to the branch).

It doesn't have an equivalent GitHub variable because GitHub Actions caches are by default scoped to the branches they were created on (more info here).

So from a migration POV, the GitLab example shown is similar to the GitHub one in terms of the behavior for both systems.