search

coopnorge / github-workflow-techdocs

MIT License
1 stars 0 forks source link

Ignore vendor folder for linter #73

Closed LinMAD closed 1 year ago

LinMAD commented 1 year ago

Hi @coopnorge/developer-productivity

in one of the legacy projects, techdocs workflows start catching the vendor folders for the linting and ofc its breaks. We cannot delete the vendor folder since it's cupeled with internal integration tests.

Workflow output:

**vendor**/github.com/spaolacci/murmur3/README.md
**vendor**/github.com/philhofer/fwd/README.md:6 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Is there a way to configure folders for exclude?

nhhagen commented 1 year ago

How can we reproduce this? Do you have a link to a GitHub actions run that shows this behaviour?

LinMAD commented 1 year ago

@nhhagen https://github.com/coopnorge/member-api/pull/236

nhhagen commented 1 year ago

We are using https://github.com/dorny/paths-filter to drive what files are validated. I'm not sure if this actions has support for excluding files. We still want to validate all markdown files written by us, not only the ones in the docs/ directory. Here is a snippet of the current implementation:

https://github.com/coopnorge/github-workflow-techdocs/blob/5ed11418d390a9af2a8ddb0d6af16f492627fa12/.github/workflows/techdocs.yaml#L43-L54

A while back we also decided that we should stop vendoring dependencies to avoid these cases. Version locking should be enough.

The easiest fix here is to stop vendoring. You might also want to look into https://github.com/dorny/paths-filter or other similar actions to figure out if there is a way to exclude directories.