Add custom_dc/env.list to .gitignore

[wittrock]

The instructions for running a custom datacommons include creating a file (custom_dc/env.list) which is likely to contain API keys. Add it to .gitignore to avoid accidental checkins.

[dwnoble]

Hey @wittrock , I like this change to avoid accidentally checking in API keys, but i think it's also helpful to have a template of what variables are available. What do you think about renaming env.list to env.list.sample and ignoring (like you have) env.list?

Then we'd need to update the instructions here: https://docs.datacommons.org/custom_dc/custom_data.html (https://github.com/datacommonsorg/docsite) to tell the user to copy the env.list.sample file to the env.list file

wdyt @keyurva @kmoscoe

[keyurva]

I like Dan's idea. To not break existing users, can we do it in 3 steps:

1. Create a PR with env.list duplicated as env.list.sample.
2. Update the doc that uses the latter.
3. Create a PR that removes env.list and adds it to .gitignore.

Thoughts?

[kmoscoe]

Yes, I like Dan's approach too, where they create a copy of the sample instead of directly editing it.

…

On Fri, Aug 23, 2024, 11:10 AM Keyur Shah ***@***.***> wrote: I like Dan's idea. To not break existing users, can we do it in 3 steps: 1. Create a PR with env.list duplicated as env.list.sample. 2. Update the doc that uses the latter. 3. Create a PR that removes env.list and adds it to .gitignore. Thoughts? — Reply to this email directly, view it on GitHub <#4573 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHMM7UDMGS4F67FOGMTOISTZS53INAVCNFSM6AAAAABNAKAZN6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBXGU3TINRRGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[kmoscoe]

And yes, add it to .git ignore. I wonder if we should also add all the generated files to .git ignore. I was quite surprised to create a PR that added 32 generated files to it... !

…

On Fri, Aug 23, 2024, 11:16 AM Kara Moscoe ***@***.***> wrote: Yes, I like Dan's approach too, where they create a copy of the sample instead of directly editing it. On Fri, Aug 23, 2024, 11:10 AM Keyur Shah ***@***.***> wrote: > I like Dan's idea. To not break existing users, can we do it in 3 steps: > > 1. Create a PR with env.list duplicated as env.list.sample. > 2. Update the doc that uses the latter. > 3. Create a PR that removes env.list and adds it to .gitignore. > > Thoughts? > > — > Reply to this email directly, view it on GitHub > <#4573 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BHMM7UDMGS4F67FOGMTOISTZS53INAVCNFSM6AAAAABNAKAZN6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBXGU3TINRRGQ> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >

[wittrock]

Done, created :

1. [custom_dc] Add env.list.sample #4577 to add env.list.sample and
2. [custom_dc] Update instructions to refer to env.list.sample docsite#488 to update the docs

Those two should merge first, then this one.

[wittrock]

Also split out my setup instructions change into #4578