googleapis / googleapis/release-please

Multiple paths for submodule commits collection

Open
#662 0 comments 3 reactions 0 assignees View on GitHub
needs design type: feature request
Dominant language
TypeScript
Stars
7.5k
Forks
588
Avg merge
12h 16m
Merged PRs (30d)
7

Description

Thanks for adding the monorepo support! I found it generally useful for common monorepo practices except the case when you want to collect commits that touched anything from a list of paths for a submodule. This is useful in following scenarios:
* when there are shared code in the repo and you want to collect commits that touched shared code in the release note of the consuming module.
* when you have multiple root folders for a submodule, such as separated Infrastructure and application code

**Is your feature request related to a problem? Please describe.**
No way to define a list of paths to match commits for a submodule in a monorepo.

**Describe the solution you'd like**
Add a separate argument to support a list of paths for commit matching, the existing `path` parameter should not be touched since there are use cases to match paths that do not contain the module manifest file (such as `package.json` for nodejs)

**Describe alternatives you've considered**
Use labels to match commits, not sure if that's supported in Github commits, looks like only PRs can have labels.

**Additional context**
Example monorepo structure:
```
infra/stackA
infra/stackB
common/sharedC
app/serviceA
app/serviceB
```
If both `serviceA` and `serviceB` depends on `sharedC`, I would like to collect messages from commits that touched `sharedC` when I release `serviceA` or `serviceB`. I may have infrastructure code `stackA` to deploy `serviceA`, hence any commits that touches `stackA` should also appear in release note of `serviceA`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.