Kotlin / binary-compatibility-validator

Public API management tool
Apache License 2.0
759 stars 55 forks source link

allow apiDumpDirectory outside projectDir if inside rootProjectDir #227

Closed robstoll closed 4 weeks ago

robstoll commented 1 month ago

Shall be understood as pre-work, I guess that there are test which will fail now (as the check changed) and additional tests would be good which still ensure that we cannot write outside the rootProject dir.

This change allows that e.g. in an multimodule project all api files are written to a single place within the rootProject dir (in my case I would like to put everything into rootProjectDir/misc/api and use apiDumpDirectory = rootProject.projectDir.relativeTo(project.projectDir).resolve("misc/api").toString()

fzhinkin commented 1 month ago

Hey @robstoll! Could you please elaborate on your plans regarding this PR?

I waited for a while because of:

Shall be understood as pre-work

But it feels like the time to ask has come :)

robstoll commented 1 month ago

Sorry, wasn't clear enough. Shall be understood as pre-work for a maintainer to take over (I don't mind if you accept the PR like this but I guessed that some additional tests would be required).I have opened this PR via web-gui and have currently not the time to check it out build etc.

fzhinkin commented 4 weeks ago

@robstoll, if you're willing to add a new feature to the BCV, please follow contributing guidelines and open an issue describing why it's needed, what problems it solves, and how it is supposed to work. If there will be a consensus that the feature should be supported, maybe someone will take it over and implement it.