Thank you Lari! Except for updating .md docs, we need to update various API docs [1]. These docs are generated from code automatically (annotations in code files).
For these special doc PRs, can we set them to run only build (compile) tests and skip other code tests? ~~~~~~~~~~ [1] Admin API docs: - pulsar-admin: update https://github.com/apache/pulsar/tree/master/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli - REST API: update https://github.com/apache/pulsar/tree/master/pulsar-broker/src/main/java/org/apache/pulsar - Java admin API: update https://github.com/apache/pulsar/tree/master/pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin Client API docs: - Java: update https://github.com/apache/pulsar/tree/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api - CPP: update https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/include/pulsar - Python: have no idea ~~~~~~~~~~ Thank you! Yu On Fri, Sep 2, 2022 at 1:17 AM Lari Hotari <lhot...@apache.org> wrote: > On 2022/09/01 08:36:11 Yu wrote: > > # 1 > > For pure doc PRs (only update .md files), do they run the same tests as > > code PRs? > > If so, can we set them to run only doc-related tests and skip code tests > > (since they're easily failed)? > > In this way, docs can be iterated faster. > > The solution is already in place where the CI pipeline for docs is > expedited. > Some technical details about the solution: All builds steps in the GitHub > Actions workflow build jobs are skipped for PRs that include changes only > to docs. The reason why the workflows and build jobs aren't completely > skipped is that we use the "required checks" feature and it is necessary to > run all required checks also for PRs with only doc changes. > > > > > ~~~~~~~~~~~~ > > > > # 2 > > Does it make sense to add instructions for tests to the Pulsar > Contribution > > Guide? > > > > For example, > > > > * For users: > > - How to resolve test issues (common test failure reasons and solutions) > > - Who can ask for help if users are blocked and can not resolve problems > > themselves > > - How to report test bugs > > > > * For developers: > > - How do tests work? (mechanism, Apache rules, etc) > > - How can I add/update tests? (quotas [1], limitations, notes, etc) > > Good suggestions. > > In general, I hope we find better ways to listen to the voice of our > contributors. What is their contribution experience? How did they feel > about it? > > Perhaps we could decide to conduct surveys? GitHub discussions has support > for polls [1] so that is one option as a technical solution for asking for > feedback in a way where there would be a low barrier to respond. > > -Lari > > [1] https://github.blog/changelog/2022-04-12-discussions-polls/ >
