Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to write the subsystem field in PR description, to distinguish whether the PR relates to DM or TiCDC #3195

Closed
Tracked by #3194
Rustin170506 opened this issue Oct 29, 2021 · 11 comments · Fixed by #3549

Comments

@Rustin170506
Copy link
Member

No description provided.

@Rustin170506
Copy link
Member Author

cc: @maxshuang Do you have any thoughts?

@Rustin170506
Copy link
Member Author

Rustin170506 commented Nov 13, 2021

I propose:
We can introduce subsystem1,subsystem2[(dm/ticdc)]: this is commit message to solve this problem.

If it includes two projects or common files, then it doesn't need to be marked as dm or ticdc, and if only one project is modified then it is marked with parentheses.

cc @lance6716 @gozssky @amyangfei @overvenus @maxshuang What do you think?

@Rustin170506
Copy link
Member Author

For example:

  1. modify GitHub files: github: refine the actions file
  2. modify TiCDC sink: sink(ticdc): add xxx config for MySQL sink
  3. modify DM syncer: syncer(dm): increase the number of worker
  4. modify TiCDC puller and sink: puller,sink(ticdc): remove useless code

@Rustin170506
Copy link
Member Author

Or, if the trend across the repository is to merge, then I think we could just close this issue and not specifically differentiate between ticdc and dm, but for now they're still completely different products(and separate from a product perspective later on), and maybe it's necessary to differentiate between these commits.

@maxshuang
Copy link
Contributor

cc: @maxshuang Do you have any thoughts?

Do we have an easy way to force user choose a tag to extract to the title? At first, we can force user to do it manully, but do we have another solution for the next stage? Hope your expert opinion.

@asddongmen
Copy link
Contributor

For example:

  1. modify GitHub files: github: refine the actions file
  2. modify TiCDC sink: sink(ticdc): add xxx config for MySQL sink
  3. modify DM syncer: syncer(dm): increase the number of worker
  4. modify TiCDC puller and sink: puller,sink(ticdc): remove useless code

There may be multiple files with a same name in different package, shall we add the package name?
for example:

  • pipeline/sink
  • sink/sink

@maxshuang
Copy link
Contributor

For example:

  1. modify GitHub files: github: refine the actions file
  2. modify TiCDC sink: sink(ticdc): add xxx config for MySQL sink
  3. modify DM syncer: syncer(dm): increase the number of worker
  4. modify TiCDC puller and sink: puller,sink(ticdc): remove useless code

There may be multiple files with a same name in different package, shall we add the package name? for example:

  • pipeline/sink
  • sink/sink

I think subsystem is a rough concept, more appropriate to aggregate the pr instead of the detail package name.

@Ehco1996
Copy link
Contributor

For example:

  1. modify GitHub files: github: refine the actions file
  2. modify TiCDC sink: sink(ticdc): add xxx config for MySQL sink
  3. modify DM syncer: syncer(dm): increase the number of worker
  4. modify TiCDC puller and sink: puller,sink(ticdc): remove useless code

this lgtm, but i am looking forward to the day we don't need to distinguish DM and CDC, so the commit message will look like this:

mysql-sink: fix xx when xxx
election: fix master down when xxx

@lance6716
Copy link
Contributor

can the bot scan the file changes of the PR, if some file changed under dm folder it shall attach an area/dm tag?

we can use -label:area/dm in search box to exclude the label

@Rustin170506
Copy link
Member Author

can the bot scan the file changes of the PR, if some file changed under dm folder it shall attach an area/dm tag?

we can use -label:area/dm in search box to exclude the label

It's hard to open GitHub to look at labels when you're troubleshooting a lot of commits locally.

@Rustin170506
Copy link
Member Author

For pr and commit we need to focus on local git tool adaptations, not just GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants