cilium-cli icon indicating copy to clipboard operation
cilium-cli copied to clipboard

Updated deprecated service annotation

Open tokarev-artem opened this issue 2 years ago • 6 comments

Updated deprecated service annotation

https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.6/guide/service/annotations/#:~:text=string-,service.beta.kubernetes.io/aws%2Dload%2Dbalancer%2Dinternal,-boolean

tokarev-artem avatar Oct 17 '23 13:10 tokarev-artem

Looking good.

Could you please squash your commits into a single commit, and include a more descriptive summary and description in the commit message?

A good example of our commit message standards: https://github.com/cilium/cilium-cli/pull/1948/commits

asauber avatar Nov 01 '23 18:11 asauber

Looking good.

Could you please squash your commits into a single commit, and include a more descriptive summary and description in the commit message?

A good example of our commit message standards: https://github.com/cilium/cilium-cli/pull/1948/commits

Updated, is it acceptable? Thanks

tokarev-artem avatar Nov 02 '23 19:11 tokarev-artem

Thanks for the update. Not quite there with the commit message. Your commit message is:

Updated deprecated annotation which is deprecated
https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.6/guide/service/annotations/#:~:text=string-,service.beta.kubernetes.io/aws%2Dload%2Dbalancer%2Dinternal,-boolean
    
Signed-off-by: [email protected]

One issue is that the title of the commit message is redundant and doesn't describe the change. A better title would be clustermesh: update deprecated AWS annotation. This indicates the area of the codebase being changed, uses the active tense, starts with a verb, and gives an indication of which annotation we are talking about.

A few issues with the body of the commit message as well. If you provide a link to an external resource, you should consider it supplemental material that could disappear at any time. The body of the commit message should clearly describe the change and the reason for the change. There should also be a blank line between the title and the body.

Putting this together your commit message would be along the lines of

clustermesh: update deprecated AWS annotation

[description of the change and why it's necessary]

https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.6/guide/service/annotations/#:~:text=string-,service.beta.kubernetes.io/aws%2Dload%2Dbalancer%2Dinternal
    
Signed-off-by: [email protected]

For more information on commit standards, you can refer to the Cilium "submitting a pull request" documentation.

Some additional guidelines for good commit messages:

  • https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  • https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
  • https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing

asauber avatar Nov 07 '23 15:11 asauber

Please see the comment above regarding the commit message.

Sorry, GitHub doesn't send any notifications about PRs activity. Updated the commit message. Thanks

tokarev-artem avatar Nov 10 '23 22:11 tokarev-artem

I've kicked the kind job, it timed out reaching cilium.io.

This needs a review from @cilium/sig-clustermesh and it's good to go.

ti-mo avatar Dec 05 '23 13:12 ti-mo

Ping, is this still being worked on? Converting to draft for now.

ti-mo avatar Feb 22 '24 09:02 ti-mo

Closing, as superseded by https://github.com/cilium/cilium-cli/pull/2664.

giorio94 avatar Jul 29 '24 12:07 giorio94