updating releasemd

[longwuyuan]

Minor changes to RELEASE.md that were missed during the release v1.1.1 PR

[longwuyuan]

@cpanato @rikatz @tao12345666333

[longwuyuan]

@cpanato @strongjz seeking LGTM & Approve for easy small change to RELEASE.md

[cpanato]

when you say here what that means? where we should add this?
the second part can be something like

The tool `github-cli` cab be used to get a list of PRs

[afirth]

I wanted to ask because I just had to rebase it - why is this better than

git log <prev-tag>..main --pretty=%s

??

The list generates like

fix custom-error-pages file not exist (#7728)
Bump google.golang.org/grpc from 1.41.0 to 1.43.0 (#8054)
Remove force sync / 30s for non-external backends (#7958)
Report expired certificates (#8045) (#8046)
docs: fix typo'd executible name (#8041)
Bump github.com/spf13/cobra from 1.2.1 to 1.3.0 (#8058)
Add stream-snippet as a ConfigMap and Annotation option (#8029)
align bug report with feature request regarding kind documentation (#8051)
Disable default modsecurity_rules_file if modsecurity-snippet is specified (#8021)

and the #nnnn is automatically expanded to a link when viewing on github

[longwuyuan]

when you say here what that means? where we should add this? the second part can be something like
The tool github-cli cab be used to get a list of PRs

@cpanato Apologies, I missed editing this part. I am making the changes now. Need to get elaborate on generating the Changelog type PRs list here as well.

@afirth, thanks for your comment. I need to do a lot of explaining here.

• One reason was I was/am favoring gh-cli. I will change to your suggestion of using the git executable, after I have done some background work and find it better suited. The factors influencing the decisions are ;
  • There are 2 places we need to present the Changelog. So, at the back of my mind, I wanted to have one method to generate the Changelog, for both destinations. One place is the Changelog in github, where I realize only now, that the #nnnn will expand to a link. Thanks for helping me realize that. But there is another Changelog that is included with the helm-chart, that goes on artifacthub.io. The #nnnn almost certainly would not expand to a link outside of github, or so I think(not tested so don't know).
  • Another reason is that the git command output has the PR number at the end of each line after the PR-Title. But all past versions of our Changelog have the PR number, at the beginning of the line. It seems some trivial automation or output format flags to the git log command can produce desired output format. Just that I don't know how to make that git log command output, to produce the PR number before the PR title. I will need to read and learn how to do that.
  • Eventually I am hoping github cli can produce the Changelog format we need, both for github and artifacthub.io.
  • Please correct me and advise if I have things wrong or if I am complicating this more than it is

All, please advise/suggest if there are other thoughts/changes.
We have a history of new contributors also participating in the release process so hoping to simplify as much as possible.

[iamNoah1]

agreed with @longwuyuan. To be honest here, this question or change request is out of scope for this PR. At least IMHO. We could consider it but I would prefer to do so in a separate issue, so that we can finish up this PR.

[iamNoah1]

/triage accepted
/kind documentation
/priority important-longterm

[longwuyuan]

Noah, please check my last commit. I did put the example command there. The yaml with the valid digest, will still be in the clone, of the fork, that the person going through these steps, is editing. It's generated as part of previous steps. So can't link from project... But i suppose we could put a note. Thanks, ; Long

…

On Thu, 13 Jan, 2022, 4:20 PM Noah Ispas, ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In RELEASE.md <#8135 (comment)> : > @@ -223,8 +227,16 @@ Promoting the images basically means that images, that were pushed to staging co ### f. Edit the changelog [Changelog.md](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md) -- Add the PRs merged after previous release -- If you use the github cli https://cli.github.com/, then that is one useful command to get this list of PRs +- Each time a release is made, a new section is added to the Changelog.md file +- A new section in the Changelog.md file consists of 3 components listed below + - the "Image" + - the "Description" + - the "PRs list" +- Look at the previous content to understand what the 3 components look like. +- You can easily get the "Image" from a yaml manifest. +- You need to have a good overview of the changes introduced in this release and based on that you write a description +- And then you add a list of the PRs merged, since the previous release +- If you use the github cli https://cli.github.com/, then that is one easy way to get this list of PRs Maybe add the example command — Reply to this email directly, view it on GitHub <#8135 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWU3QYCK3RW37V5SI5TUV2U6VANCNFSM5LZ4F5QA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[iamNoah1]

Fair enough Long :) a Note would be good I guess
Cheers

[longwuyuan]

@iamNoah1 you can see here for what it will look like https://github.com/longwuyuan/ingress-nginx/blob/releasemd/RELEASE.md

[iamNoah1]

/lgtm

[cpanato]

/approve
/lgtm

i think i don't have permission to approve here so
/assign @rikatz

[strongjz]

/lgtm

Thanks @longwuyuan

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cpanato, iamNoah1, longwuyuan, strongjz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [strongjz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment