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.

Sign up for GitHub

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

Update releasing workflow #5026

Merged
merged 8 commits into from
Feb 7, 2023
Merged

Update releasing workflow #5026

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4fff839
Update releasing instructions
KnVerey Feb 2, 2023
8b51c29
Allow gorepomod to update plugin mod files
KnVerey Feb 2, 2023
9a1a203
Update example targets
KnVerey Feb 2, 2023
03669a1
Improve error message and fix typo in iampolicygenerator module name
KnVerey Feb 2, 2023
e6c16a6
Restore previous test-go-mod and commit changes
KnVerey Feb 2, 2023
9c116e9
Bespoke mod edits no longer needed if gorepomod pins all modules
KnVerey Feb 2, 2023
57d8583
Fix lint errors
KnVerey Feb 2, 2023
63c37b1
Update releasing/README.md
KnVerey Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This tool is sponsored by [sig-cli] ([KEP]).

## kubectl integration

To find the kustomize version embedded in recently version of kubectl, run `kubectl version`:
To find the kustomize version embedded in recent versions of kubectl, run `kubectl version`:

```sh
> kubectl version --short --client
Expand Down
1 change: 0 additions & 1 deletion cmd/gorepomod/internal/arguments/args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ var (
"docs",
"examples",
"hack",
"plugin",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jeff specifically added this in #3910. Why? 😕

"releasing",
"site",
}
Expand Down
2 changes: 2 additions & 0 deletions cmd/gorepomod/internal/edit/editor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ func (e *Editor) Tidy() error {
func (e *Editor) Pin(target misc.LaModule, oldV, newV semver.SemVer) error {
err := e.run(
"edit",
"-dropreplace="+target.ImportPath(),
"-dropreplace="+target.ImportPath()+"@"+oldV.String(),
"-require="+target.ImportPath()+"@"+newV.String(),
)
if err != nil {
Expand Down
7 changes: 4 additions & 3 deletions cmd/gorepomod/internal/repo/dotgitdata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ func (dg *DotGitData) AbsPath() string {

// NewDotGitDataFromPath wants the incoming path to hold dotGit
// E.g.
// ~/gopath/src/sigs.k8s.io/kustomize
// ~/gopath/src/github.com/monopole/gorepomod
//
// ~/gopath/src/sigs.k8s.io/kustomize
// ~/gopath/src/github.com/monopole/gorepomod
func NewDotGitDataFromPath(path string) (*DotGitData, error) {
if !utils.DirExists(filepath.Join(path, dotGitFileName)) {
return nil, fmt.Errorf(
Expand Down Expand Up @@ -126,7 +127,7 @@ func (dg *DotGitData) checkModules(modules []*protoModule) error {
}
} else {
// Do the relative path and short name make sense?
if !strings.HasSuffix(pm.PathToGoMod(), string(shortName)) {
if !strings.HasPrefix(string(shortName), "plugin/") && !strings.HasSuffix(pm.PathToGoMod(), string(shortName)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to exclude plugins here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. I think this was a left over attempt to fix the problem that in the end was caused by one plugin having an invalid module name. I'll revert it in the unpinning PR.

return fmt.Errorf(
"in %q, the module name %q doesn't match the file's pathToGoMod %q",
file, shortName, pm.PathToGoMod())
Expand Down
90 changes: 37 additions & 53 deletions releasing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ We use the `release-blocker` tag to track issues that need to be solved before t
It is also a good idea to scan any [untriaged issues](https://github.com/kubernetes-sigs/kustomize/issues?q=is%3Aissue+is%3Aopen+label%3Aneeds-triage) for potential blockers we haven't labelled yet before proceeding.

### Consider fetching new OpenAPI data

Ideally, Kustomize's embedded openapi data would cover a wide range of Kubernetes releases. But today, we only embed a specific version. This means updating that version can be disruptive to people who still use older Kubernetes versions and depend on API versions that were removed in later releases. However, by remaining out of date, we will not support GVKs introduced in more recent releases. So far, we have leaned in favour of the older versions, because some removed GVs are for very popular APIs. This should be constaintly reevaluated until a better solution is in place. See issue https://github.com/kubernetes-sigs/kustomize/issues/5016.
KnVerey marked this conversation as resolved.
Show resolved Hide resolved

The Kubernetes OpenAPI data changes no more frequently than once per quarter.
You can check the current builtin versions that kustomize is using with the
following command.
Expand Down Expand Up @@ -105,10 +108,7 @@ source releasing/helpers.sh
#### Authenticate to github using [gh](https://github.com/cli/cli) (version [1.8.1](https://github.com/cli/cli/releases/tag/v1.8.1) or higher).

```
# Use your own token
GITHUB_TOKEN=deadbeefdeadbeef

echo $GITHUB_TOKEN | gh auth login --scopes repo --with-token
gh auth login
```

## Release `kyaml`
Expand Down Expand Up @@ -174,20 +174,9 @@ createBranch pinToKyaml "Update kyaml to $versionKyaml"
createPr
```

Run local tests while GH runs tests in the cloud:
```
testKustomizeRepo
```

Wait for tests to pass, then merge the PR:
```
gh pr status
```
```
gh pr merge -m
```
Review the resulting PR and get a collaborator to LGTM. Wait for CI to pass.

Get back on master and do paranoia test:
Once the PR merges, get back on master and do paranoia test:
```
refreshMaster &&
testKustomizeRepo
Expand Down Expand Up @@ -238,20 +227,9 @@ createBranch pinToCmdConfig "Update cmd/config to $versionCmdConfig" &&
createPr
```

Run local tests while GH runs tests in the cloud:
```
testKustomizeRepo
```
Review the resulting PR and get a collaborator to LGTM. Wait for CI to pass.

Wait for tests to pass, then merge the PR:
```
gh pr status # rinse, repeat
```
```
gh pr merge -m
```

Get back on master and do paranoia test:
Once the PR merges, get back on master and do paranoia test:
```
refreshMaster &&
testKustomizeRepo
Expand Down Expand Up @@ -287,6 +265,14 @@ Undraft the release on the [kustomize repo release page]:

## Release the kustomize CLI

#### For major releases: increment the module version

Update `module sigs.k8s.io/kustomize/kustomize/vX` in `kustomize/go.mod` to the version you're about to release, and then update all the `require` statements across the module to match.

Search for uses of the version number across the codebase and update them as needed.

Example: https://github.com/kubernetes-sigs/kustomize/pull/5021

#### Pin to the new API

```
Expand All @@ -299,20 +285,9 @@ createBranch pinToApi "Update api to $versionApi" &&
createPr
```

Run local tests while GH runs tests in the cloud:
```
testKustomizeRepo
```
Review the resulting PR and get a collaborator to LGTM. Wait for CI to pass.

Wait for tests to pass, then merge the PR:
```
gh pr status # rinse, repeat
```
```
gh pr merge -m
```

Get back on master and do paranoia test:
Once the PR merges, get back on master and do paranoia test:
```
refreshMaster &&
testKustomizeRepo
Expand Down Expand Up @@ -351,30 +326,39 @@ Undraft the release on the [kustomize repo release page]:

* Visit the [release page] and edit the release notes as desired.

## Update example test target
## Return the repo to development mode

Go back into development mode, where all modules depend on in-repo code:

```
gorepomod unpin api --doIt &&
gorepomod unpin cmd/config --doIt &&
gorepomod unpin kyaml --doIt
```

[Makefile]: https://github.com/kubernetes-sigs/kustomize/blob/master/Makefile

Edit the `prow-presubmit-target` in the [Makefile]
to test examples against your new release.
to test examples against your new release. For example:

```
sed -i "" "s/LATEST_V4_RELEASE=.*/LATEST_V4_RELEASE=v4.3.0/" Makefile
sed -i "" "s/LATEST_V5_RELEASE=.*/LATEST_V5_RELEASE=v4.3.0/" Makefile
```

Create the PR:
```
createBranch updateProwExamplesTarget "Test examples against latest release" &&
createBranch unpinEverything "Back to development mode; unpin the modules" &&
createPr
```

Wait for tests to pass, then merge the PR:
```
gh pr status # rinse, repeat
```
Review the resulting PR and get a collaborator to LGTM. Wait for CI to pass.

Once the PR merges, get back on master and do paranoia test:
```
gh pr merge -m
refreshMaster &&
testKustomizeRepo
```


## Publish Official Docker Image

[k8s.io]: https://github.com/kubernetes/k8s.io
Expand Down