Add manifest of files maintained elsewhere #209
Conversation
| <!-- **Squash your commits**: Please use an | ||
| [interactive rebase](https://help.github.com/articles/about-git-rebase/) | ||
| interactive rebase (https://help.github.com/articles/about-git-rebase/) |
There was a problem hiding this comment.
oh, not related, but I think we explain those steps in our contributors guide as well https://docs.docker.com/opensource/workflow/work-issue/#/pull-and-rebase-frequently
| @@ -0,0 +1,18 @@ | |||
| # Files and directories here are not edited in the docker.github.io repo. | |||
There was a problem hiding this comment.
If this file is only used for automation, I suggest to either make it hidden (.something), or we can add a hack/ directory to put everything in related to automation.
|
I think it should at least be able to seen, so it c an be referenced when a PR fails and the contributor can look at it. WDYT? I added a bit more info into comments of the file, for humans. |
|
We can link to it even if it's hidden, it's just that it's not visible when people to a checkout. No showstopper though; just something we should discuss / look at when we start to use it for automation. |
|
LGTM 🚲 🏠 on the file name: May want to look at python or git's file matching syntax for this use case. Either way, this perfectly addresses my original concern. Thanks! |
|
I changed it to .NOT_EDITED_HERE.txt and left it in the root for now, as a compromise. I like the idea that if someone is browsing the repo on Github it will be right at the top. I'm going to go ahead and merge it. We can add exclusions later if we want. |
The plan is for this file to be used by a CI process which will fail a PR if it includes changes to any of these files.
Describe the proposed changes
Adds a manifest of files which should not be edited in this repo because they are
maintained elsewhere. The intent is for this file to be used by a CI process to fail
a PR which changes one of these files.
Project version
This change will need to go into all the vnext branches.
Related issue
#208
Related issue or PR in another project
distribution/distribution#1985
Please take a look
/cc @stevvooe @thaJeztah @johndmulhausen and please CC others who will know which files or directories should be excluded from the other projects.
The plan is for this file to be used by a CI process which
will fail a PR if it includes changes to any of these files.