Cannot have docs/ directory at the root of project

[imaNNeo]

Environment

• pub version or flutter pub version: Pub 2.16.1
• OS version: macOS Big Sur version 11.4 (20F71)
• Are you using the Chinese community mirror or a corporate firewall? No

Problem

I need to have a directory called docs at the root of my project (because I want to use docs.page service to generate documentation pages).
When I run flutter pub publish --dry-run it fails with the error below:

Package validation found the following potential issue:
* Rename the top-level "docs" directory to "doc".
  The Pub layout convention is to use singular directory names.
  Plural names won't be correctly identified by Pub and other tools.

Although I tried to put docs/ in my .pubignore file, it didn't work.

You can check this failing workflow for more details.

There is a similar closed issue here: #2976
I couldn't find any solution there.

[sigurdm]

First this is only a warning. You can publish to pub.dev anyways.

I think we might have to rethink this if docs.page becomes a thing.

Anyways the validator is listing files with listDir(entryPoint.root.dir) instead of entryPoint.root.listFiles() if we change that .pubignores would be respected. But that would still mean the docs folder would not get published - that might or might not be what we want.

@jonasfj WDYT?

[jonasfj]

I think it's fine to respect .pubignore in the validators. That makes sense, and would be a possible workaround.

But this is just a warning it can be ignored, see:

pub/lib/src/validator/directory.dart

Line 35 in b93bf88

warnings.add('Rename the top-level "$dir" directory to '

You get this warning because you're package is violating: https://dart.dev/tools/pub/package-layout

Closing this as working as intended.

[jonasfj]

Filed:

• Respect .pubignore in validators #3327
• Messages from validator/directory.dart should link to dart.dev documentation #3328

[imaNNeo]

ocs folder would not get publish

I think we don't need to publish docs directory.
It only needs to exist in the repository.

[imaNNeo]

I use this Github Action to publish my package in CI / CD
I don't understand how I can configure it to ignore that specific warning.