Write a .gitignore file into htmlcov

[nedbat]

To keep people from accidentally committing the HTML report to git, or to keep them from having to edit their .gitignore to prevent it, the html command can write a .gitignore file into the directory.

It should only write the file if it doesn't already exist. This would let people edit the .gitignore if they did want to commit the report.

Some people suggested only writing the file if it's a git repo, but that's over-engineered. One more tiny dot file inside the report directory won't hurt.

[nedbat]

This is implemented in ea6906b

[nedbat]

This is now released as part of coverage 6.1.

[emcd]

It should only write the file if it doesn't already exist. This would let people edit the .gitignore if they did want to commit the report.

Hi @nedbat , the functionality described in the initial post to this issue does not match what was implemented in coverage/html.py as part of ea6906b . I.e., the implemented functionality unconditionally overwrites an existing .gitignore. Was this intentional?

(As someone who had a preexisting .gitignore in my HTML report directory, I would've preferred not to have mine overwritten.)

Thanks.

[nedbat]

@emcd Sorry about that, I see your point. I can make an adjustment. Can you tell me more about how you used it? What was in your .gitignore file originally?

BTW, very impressive workflow file, in a few ways: https://github.com/edaa-org/pyEDAA.ProjectModel/blob/master/.github/workflows/Pipeline.yml

[nedbat]

I've changed the code in b471e55 to not overwrite an existing file. I'd still like to understand more about your use case though.