search

firecow / gitlab-ci-local

Tired of pushing to test your .gitlab-ci.yml?
MIT License
2.42k stars 136 forks source link

Documentation: Rename example for env file #1433

Closed gbmd closed 5 days ago

gbmd commented 6 days ago

The readme suggests the following: Add a .gitlab-ci-local-env file to the current working directory or a .env file in $HOME/.gitlab-ci-local. According to gcl --help though, the default name is .gitlab-ci-local-variables.yml. It took me some time to figure out why my variables were not accessible inside my executor's docker containers. So I would suggest to make the documentation a bit more self-explanatory like this:

Add a .gitlab-ci-local-variables.yml file to the current working directory or a .env file in $HOME/.gitlab-ci-local..

Thanks in advance!

ANGkeith commented 6 days ago

This is frequently confused, and you are not the first to be confused with it...

(i highly suspect it's because of the key word dotenv / env😅)

This https://github.com/firecow/gitlab-ci-local?tab=readme-ov-file#dotenv-file section of the docs is referring to the following image

For what you are trying to do, they're actually documented under: https://github.com/firecow/gitlab-ci-local?tab=readme-ov-file#home-file-variables https://github.com/firecow/gitlab-ci-local?tab=readme-ov-file#project-file-variables

Hopefully this is clearer now. Feel free to add comment to https://github.com/firecow/gitlab-ci-local/tree/doc/readme?tab=readme-ov-file#via-a-file if you feel there's anywhere that it can be phrased better

ANGkeith commented 5 days ago

fixed in https://github.com/firecow/gitlab-ci-local/pull/1434