search

kubernetes-sigs / krew

📦 Find and install kubectl plugins
https://krew.sigs.k8s.io
Apache License 2.0
6.41k stars 369 forks source link

fix contributors list in release notes #830

Closed chriskim06 closed 1 year ago

chriskim06 commented 1 year ago

Fixes #... Related issue: #...

chriskim06 commented 1 year ago

/assign @ahmetb

ahmetb commented 1 year ago

Funny I don't remember running into this. I ran git show v0.4.4 after invoking this script and the contributor list was (and still is) there. And I also see https://github.com/kubernetes-sigs/krew/releases/tag/v0.4.4 is populated (did you edit it?) - so I don't know if there's a problem.

chriskim06 commented 1 year ago

Funny I don't remember running into this. I ran git show v0.4.4 after invoking this script and the contributor list was (and still is) there. And I also see https://github.com/kubernetes-sigs/krew/releases/tag/v0.4.4 is populated (did you edit it?) - so I don't know if there's a problem.

ya sorry i mentioned it in slack but i manually edited it

when i run this on master the contributor list is empty

  ckim@not-computer î‚°  ~/src/chriskim06/krew î‚°  î‚  master: $|u= î‚°
  19:18 î‚° TAG=v0.4.4 hack/make-release-artifacts.sh
Creating krew-darwin_amd64.tar.gz archive.
a ./LICENSE
a ./krew-darwin_amd64
krew-darwin_amd64.tar.gz checksum: a5784671b6a28eee1770e68a73aa1055e92e1f4955067ab3986e821679235e4c
Written out/krew-darwin_amd64.tar.gz.sha256.
Written out/krew.yaml.

  ckim@not-computer î‚°  ~/src/chriskim06/krew î‚°  î‚  master: $|u= î‚°
  19:18 î‚° TAG=v0.4.4 hack/make-release-notes.sh
Installation
------------
To install this release, refer to the instructions at https://github.com/kubernetes-sigs/krew/blob/v0.4.4/README.md.

Release Assets
--------------
Artifacts for this release can be downloaded from the following links.
It is recommended to follow [installation instructions](https://github.com/kubernetes-sigs/krew/blob/v0.4.4/README.md)
and not using these artifacts directly.

- https://github.com/kubernetes-sigs/krew/releases/download/v0.4.4/krew-darwin_amd64.tar.gz
- https://github.com/kubernetes-sigs/krew/releases/download/v0.4.4/krew-darwin_amd64.tar.gz.sha256
- https://github.com/kubernetes-sigs/krew/releases/download/v0.4.4/krew.yaml

Thanks to our contributors for helping out with v0.4.4:

(krew v0.4.4 is tagged on Wed Jul 19 02:18:53 UTC 2023.)

<details>
<summary>Merged pull requests</summary>

Collecting pull request that were merged since the last release: v0.4.4 (2023-07-13 21:53:48 +0000 UTC)
</details>
chriskim06 commented 1 year ago

actually think i need to look at this more

/hold

ahmetb commented 1 year ago

when i run this on master the contributor list is empty

that's normal since you probably have v0.4.4 already tagged, but release notes must be computed before tagging in https://github.com/kubernetes-sigs/krew/blob/22f508a02fba9e1b4039ac69d583a70f1b5e510f/docs/RELEASING_KREW.md.

So if you git tag -d v0.4.4, I expect existing instructions to work.

i manually edited it

I think this is how we've always done it on every release. I don't think GitHub picks up a tag's message/annotations as release description, unless you integrate with GitHub API.

chriskim06 commented 1 year ago

ah ok i see. i forgot that we manually uploaded the release notes and didnt have it in the ci till https://github.com/kubernetes-sigs/krew/pull/781/files

actions/checkout does a shallow clone so thats why checking the git log doesnt work there. think we'll need to update this https://github.com/actions/checkout/blob/v3.5.3/action.yml#L65-L67 to 0

chriskim06 commented 1 year ago

setting the fetch depth fixes it. here's a run i did (after deleting the v0.4.4 tag) https://github.com/chriskim06/krew/actions/runs/5683675067/job/15404722587 and here's the release it created https://github.com/chriskim06/krew/releases/tag/v0.4.4-test

the contributor list is messed up since i dont have the 0.4.3 tag but this simplifies the release process for sure.

lmk what you think @ahmetb, ~ill update the release docs later today as well. didnt have more time right now to do that after testing this out~ made some changes there

chriskim06 commented 1 year ago

/hold cancel

ahmetb commented 1 year ago

/lgtm /approve Thanks!

k8s-ci-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, chriskim06

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](https://github.com/kubernetes-sigs/krew/blob/master/OWNERS)~~ [ahmetb,chriskim06] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment