[feature] Rancher UI dashboard commands #474
Conversation
| @@ -838,3 +880,47 @@ const checkRancherRCDepsTemplate = `{{- define "componentsFile" -}} | |||
| * {{ .Content }} ({{ .File }}, line {{ .Line }}) | |||
| {{- end}} | |||
| {{ end }}` | |||
|
|
|||
| const updateDashboardReferencesScript = `#!/bin/bash | |||
There was a problem hiding this comment.
Can you comment this explaining what this logic does?
There was a problem hiding this comment.
Yep, I also thought that it was missing some comments explaining a few of those lines.
Added a few comments explaining most of the steps in this script.
There was a problem hiding this comment.
Was this a script taken from somewhere else or you wrote it? If it's ECM code, please update this to be POSIX complaint and use /bin/sh. Run this through shellcheck to catch any kind of issues.
| Auth *Auth `json:"auth"` | ||
| User *User `json:"user"` | ||
| K3s *K3s `json:"k3s"` | ||
| UI *UI `json:"ui"` |
There was a problem hiding this comment.
I don't think this code needs to know about the UI repo unless there's code to check that the tag was created from the GitHub action when a tag is created in the dashboard repo.
| UIRepoName string `json:"ui_repo_name"` | ||
| PreviousTag string `json:"previous_tag"` | ||
| ReleaseBranch string `json:"release_branch" validate:"required"` | ||
| DryRun bool `json:"dry_run"` |
There was a problem hiding this comment.
Despite using dry_run as a config in other places, I think using the global flag defined in cmd/release/cmd/root.go is way more convenient and better and easier to check if it's on or not
| Tag string | ||
| RancherUpstreamURL string `json:"rancher_upstream_url" validate:"required"` | ||
| RancherReleaseBranch string `json:"rancher_release_branch" validate:"required"` | ||
| DryRun bool `json:"dry_run"` |
There was a problem hiding this comment.
Same as before, but adding that I'll definitely make a PR updating the rancher cmd
rafaelbreno
force-pushed
the
feature/rancher-ui-dashboard
branch
from
cd5900c
to
453d7b5
Compare
release/release.go
Outdated
| @@ -853,3 +913,17 @@ As always, we welcome and appreciate feedback from our community of users. Pleas | |||
| - [Check out our documentation](https://rancher.com/docs/k3s/latest/en/) for guidance on how to get started or to dive deep into K3s. | |||
| - [Read how you can contribute here](https://github.com/rancher/k3s/blob/master/CONTRIBUTING.md) | |||
| {{ end }}` | |||
|
|
|||
| const uiReleaseNoteTemplate = ` | |||
There was a problem hiding this comment.
I am not sure about this, but shouldn't these constants for templates be defined at the beginning of the file?
| Use: "dashboard [ga,rc] [version]", | ||
| Short: "Tag dashboard releases", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if len(args) < 2 { |
There was a problem hiding this comment.
Same thing here, see about doing validations on the standard Validation Arguments function of cobra like:
https://github.com/rancher/ecm-distro-tools/blob/master/cmd/release/cmd/push.go#L47
| dashboardImagesBaseURL = "https://github.com/" + dashboardOrg + "/" + dashboardRepo + "/releases" | ||
| ) | ||
|
|
||
| func CreateRelease(ctx context.Context, client *github.Client, r *ecmConfig.DashboardRelease, opts *repository.CreateReleaseOpts, rc bool) error { |
There was a problem hiding this comment.
Can we get some documentation on public functions?
| ) | ||
|
|
||
| func CreateRelease(ctx context.Context, client *github.Client, r *ecmConfig.UIRelease, opts *repository.CreateReleaseOpts, rc bool) error { | ||
| fmt.Println("validating tag") |
There was a problem hiding this comment.
I am not opposed to logging here.
However, I remember some reviews I got telling me not to log anything at this level unless using the debug flag.
| Use: "dashboard [version]", | ||
| Short: "Update Rancher's Dashboard and UI references and create a PR", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if len(args) < 1 { |
There was a problem hiding this comment.
Let's try to use the standard ValidationArgs function of cobra for validating args?
https://github.com/rancher/ecm-distro-tools/blob/master/cmd/release/cmd/push.go#L47
Commands added
$ release [repo] release-notesAdded support for
repo:uidashboardCommand examples:
$ release generate ui release-notes --milestone v2.9.1 --prev-milestone v2.9.0$ release generate dashboard release-notes --milestone v2.9.1 --prev-milestone v2.9.0This command will generate and output the release notes, based on two milestones.
$ release [repo] [ga,ra] [version]Added support for
repo:uidashboard$ release tag dashboard rc v2.9.1tags https://github.com/rafaelbreno/rancher-dashboard/releases/tag/v2.9.1-rc1$ release tag dashboard ga v2.9.1tags https://github.com/rafaelbreno/rancher-dashboard/releases/tag/v2.9.0$ release update rancher dashboard [version]This command is ran in the
rancher/rancherfork clone, where it will run a script that updates the two necessary fields, and opens a PR againstrancher/rancher.Command examples:
$ release update rancher dashboard v2.9.1-rc8opens Bump Dashboard tov2.9.1-rc8rancher#46947