Build: `manifest.yml` filename choice conflicts with CloudFoundry

Created on 22 Mar 2020  路  5Comments  路  Source: netlify/build

hey friends

just realized something - manifest.yml is a common name already taken by the cloudfoundry ecosystem - https://github.com/search?q=filename%3Amanifest.yml&type=Code

it is so generic that it can be easily confused, or difficult to search for.

suggest naming something more netlify specific, so it is easy to search in google and has no ambiguity.

i dont feel VERY strongly about this, just a "take it or leave it" suggestion

bug

All 5 comments

Actually, the naming of the manifest.yml file was directly influenced by its common usage for similar purposes across a variety of platforms (https://github.com/netlify/build/issues/963#issuecomment-599356251).

For the search issue, I suspect most people would use a phrase like "Netlify manifest.yml" in their first search attempt, but if they do use "manifest.yml` alone and find no relevant results, I think it's pretty safe to assume they'll then add "Netlify" to the query to find what they're looking for. Even today, with very little relevant content published yet, searching for "Netlify manifest.yml" on Google turns up this repo as the first result.

I think the only potential concern could be a file conflict, if a person wanted to deploy a plugin package to CloudFoundry as well as use it as a Netlify build plugin. I can't imagine a situation where that would be the case, though.

ok :)

Would a conflict exist if the manifest.yml is going into a netlify build plugin package? At first glance, I'm thinking it wouldn't so I think leaving the name as manifest is fine.

i just like filenames to be unambiguous if we can help it. we live in an ecosystem with other people who have manifests

Agreed on generally preferring unambiguous configuration filenames, but my thinking is similar to @talves - a build plugin is a standalone, purpose built npm package, so the "Netlify" context is solidly implied.

Was this page helpful?
0 / 5 - 0 ratings