beachball icon indicating copy to clipboard operation
beachball copied to clipboard

Add the ability to ignore certain files

Open kenotron opened this issue 5 years ago • 8 comments

Should we have a .beachballignore file or maybe an entry in the package.json like we already have?

kenotron avatar Sep 04 '19 20:09 kenotron

I think we should target reusing the beachball key in the package.json. This way we avoid adding more config files around for now. We can think more holistically about config in another change.

kenotron avatar Sep 04 '19 20:09 kenotron

Hey @kenotron ! Was thinking about this one recently. Is this something I can help with? What does this entail:

target reusing the beachball key in the package.json

lynamemi avatar Oct 04 '19 20:10 lynamemi

I made beachball check to no longer barf on uncommitted files... does that address your needs?

kenotron avatar Oct 04 '19 21:10 kenotron

The original need was to make it so PRs with just Markdown files edited could be merged in without change files (and associated build errors) so I don't think so.

lynamemi avatar Oct 04 '19 21:10 lynamemi

So the part you're looking for is something inside getChangedPackages.

kenotron avatar Oct 04 '19 22:10 kenotron

Ok cool, I'll take a look.

lynamemi avatar Oct 04 '19 22:10 lynamemi

Looks like something like this might work? Although given this is an open source library and not in OUIFR, probably a bad idea to bake this in, which probably brings us back to a .beachballignore file. Thoughts?

function getAllChangedPackages(branch: string, cwd: string) {
  ...
  const ignoredFiles = ['CHANGELOG.md', 'CHANGELOG.json', '*.md'];
  ...
}

lynamemi avatar Oct 07 '19 15:10 lynamemi

On the one year anniversary since the last comment, I'd like to add my vote for this feature! We have .stories.jsx and docs.mdx files that are triggering changes; it would be great if we could skip documentation.

dpouliot avatar Oct 07 '20 19:10 dpouliot