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.

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

Improvement: Grafana release process minor improvements #17661

Merged
merged 9 commits into from Jun 24, 2019

Conversation

@gotjosh
Copy link
Contributor

gotjosh commented Jun 19, 2019

I've done a Grafana release once per day this week. During the process, I've identified tiny wins that can help avoid confusion by being a bit more explicit and streamlining the process. On top of this, I've contributed back whatever has not been documented on the release document itself.

Quite frankly, while this is far from a fully automated process it's a small move of the gauge in that direction. Quite sure there are other similar wins, I just chose the ones I could do in the shortest amount of time.

1. b7f15e9 looks like: no longer included due to conflicting with copy/paste of commands.

Screenshot 2019-06-18 at 16 27 47

  1. 50678e8 Is fairly explicit

  2. a1e19d8 looks like:

Screenshot 2019-06-19 at 11 46 53

TODO

  • update the documentation to include 3. as a step
  • create a follow up issue to encapsulate actions and functions related with GitHub within the client. #17734
@gotjosh gotjosh requested review from xlson and bergquist Jun 19, 2019
Copy link
Member

torkelo left a comment

Good changes! not 100% sure the number in the cherry pick commands are great as it makes copying the commands harder

scripts/cli/tasks/cherrypick.ts Outdated Show resolved Hide resolved
@gotjosh gotjosh force-pushed the release-minor-improvements branch from e9aa825 to 4b9e7e3 Jun 19, 2019
gotjosh added 5 commits Jun 18, 2019
The output of the changelog is meant to be copy/pasted with ease. When a
changelog category does not contain items is better to not display title
at all thus avoiding having the manually modify the output as we include
it in the steps of the process.
As part of a Grafana release, we need to eventually close the GitHub
milestone to indicate is done and remove all the cherry-pick labels from
issues/prs within the milestone to avoid our cherry-pick CLI command to
pick them up on the next release.

This extra task helps us do that automagically.
@gotjosh gotjosh force-pushed the release-minor-improvements branch from 4b9e7e3 to 87c7ade Jun 19, 2019
@xlson

This comment has been minimized.

Copy link
Contributor

xlson commented Jun 19, 2019

Perhaps @marefr can review this. My js-fu is way to weak for me to feel comfortable reviewing the code.

@xlson xlson requested review from hugohaggmark, marefr and markelog and removed request for xlson Jun 19, 2019
@marefr

This comment has been minimized.

Copy link
Member

marefr commented Jun 19, 2019

Looks like some great improvements 👍 Will review this in a while.

Copy link
Contributor

markelog left a comment

I would consider my comment here - https://github.com/grafana/grafana/pull/17661/files#r295312472.
Great job! Kinda hard for me to judge overall cause I didn't do a release yet :)

Co-Authored-By: Hugo Häggmark <hugo.haggmark@gmail.com>
@gotjosh gotjosh force-pushed the release-minor-improvements branch from 5899e9f to 0989fdf Jun 20, 2019
@gotjosh

This comment has been minimized.

Copy link
Contributor Author

gotjosh commented Jun 20, 2019

Have addressed all the comments/suggestions - let me know if there's anything else.

Copy link
Member

marefr left a comment

Looks great, but have a request for change

scripts/cli/tasks/closeMilestone.ts Outdated Show resolved Hide resolved
Copy link
Member

hugohaggmark left a comment

Wouldn't it be cool if the GitHubClient could hide away these raw call as well and expose functions like getIssues, getMilestone and so forth?

client.get('/issues', {
    params: {	    params: {
      state: 'closed',	      state: 'closed',
      per_page: 100,	      per_page: 100,
      labels: 'add to changelog',	      labels: 'add to changelog',
      milestone: milestone,	      milestone: milestone,
    },	    },
  });	  });
@gotjosh gotjosh requested a review from marefr Jun 24, 2019
@gotjosh

This comment has been minimized.

Copy link
Contributor Author

gotjosh commented Jun 24, 2019

Absolutely agree @hugohaggmark, noticed that whilst doing the abstraction of the client. There's also other offenders e.g. (getMarkdownLineForIssue within changelog.ts).

I would love to merge this one as is - it already has some nicely packaged changes and do the other refactor as a follow-up. I'll create the issue as I update the documentation once approved.

@marefr
marefr approved these changes Jun 24, 2019
Copy link
Member

marefr left a comment

Looks good and seems to work as expected 👍 As you said, please open a new issue for fixing/refactor any existing things.

@specificityy

This comment has been minimized.

Copy link

specificityy commented Jun 24, 2019

@gotjosh gotjosh merged commit bc94f85 into master Jun 24, 2019
2 checks passed
2 checks passed
build-branches-and-prs Workflow: build-branches-and-prs
Details
license/cla Contributor License Agreement is signed.
Details
@gotjosh gotjosh deleted the release-minor-improvements branch Jun 24, 2019
markelog added a commit that referenced this pull request Jun 24, 2019
* master:
  Project: Issue triage doc improvement (#17709)
  Improvement: Grafana release process minor improvements (#17661)
ryantxu added a commit to ryantxu/grafana that referenced this pull request Jun 24, 2019
…-mapping-to-field

* grafana/master:
  Elasticsearch: Visualize logs in Explore (grafana#17605)
  Grafana-CLI: Wrapper for `grafana-cli` within RPM/DEB packages and config/homepath are now global flags (grafana#17695)
  Add guidelines for SQL date comparisons (grafana#17732)
  Docs: clarified usage of go get and go mod (grafana#17637)
  Project: Issue triage doc improvement (grafana#17709)
  Improvement: Grafana release process minor improvements (grafana#17661)
  TimePicker: New time picker dropdown & custom range UI (grafana#16811)
  RemoteCache: redis connection string parsing test (grafana#17702)
  Fix link in pkg/README (grafana#17714)
  Dashboard: Use Explore's Prometheus editor in dashboard panel edit (grafana#15364)
  Settings: Fix typo in defaults.ini (grafana#17707)
  Project: Adds a security policy (grafana#17698)
  Project: Adds support resource docs (grafana#17699)
  Document issue triage process (grafana#17669)
  noImplicitAny: slate (grafana#17681)
  config: fix connstr for remote_cache (grafana#17675)
  Explore: Improves performance of Logs element by limiting re-rendering (grafana#17685)
  Docs: Flag serve_from_sub_path as available in 6.3 (grafana#17674)
  @grafana/runtime: expose config and loadPluginCss (grafana#17655)
  noImplicitAny: Fix basic errors (grafana#17668)
ryantxu added a commit to ryantxu/grafana that referenced this pull request Jun 25, 2019
* grafana/master:
  Elasticsearch: Visualize logs in Explore (grafana#17605)
  Grafana-CLI: Wrapper for `grafana-cli` within RPM/DEB packages and config/homepath are now global flags (grafana#17695)
  Add guidelines for SQL date comparisons (grafana#17732)
  Docs: clarified usage of go get and go mod (grafana#17637)
  Project: Issue triage doc improvement (grafana#17709)
  Improvement: Grafana release process minor improvements (grafana#17661)
  TimePicker: New time picker dropdown & custom range UI (grafana#16811)
  RemoteCache: redis connection string parsing test (grafana#17702)
  Fix link in pkg/README (grafana#17714)
  Dashboard: Use Explore's Prometheus editor in dashboard panel edit (grafana#15364)
  Settings: Fix typo in defaults.ini (grafana#17707)
  Project: Adds a security policy (grafana#17698)
  Project: Adds support resource docs (grafana#17699)
  Document issue triage process (grafana#17669)
  noImplicitAny: slate (grafana#17681)
  config: fix connstr for remote_cache (grafana#17675)
  Explore: Improves performance of Logs element by limiting re-rendering (grafana#17685)
  Docs: Flag serve_from_sub_path as available in 6.3 (grafana#17674)
ryantxu added a commit to ryantxu/grafana that referenced this pull request Jun 25, 2019
* grafana/master: (33 commits)
  API: get list of users with additional auth info (grafana#17305)
  TimePicker: fixed minor issues with new timepicker (grafana#17756)
  Explore: Parses and updates TimeSrv in one place in Explore (grafana#17677)
  @grafana/ui: release (grafana#17754)
  Password: Remove PasswordStrength (grafana#17750)
  Devenv:SAML: devenv block with saml test app (grafana#17733)
  LDAP:Docs: add information on LDAP sync feature and update LDAP sync default (grafana#17689)
  Graph: Add data links feature (click on graph) (grafana#17267)
  Explore: Changes LogsContainer from a PureComponent to a Component (grafana#17741)
  Chore: Remove tether and tether drop dependency in grafana/ui (grafana#17745)
  noImplicitAny: time region manager etc. (grafana#17729)
  Panel: Fully escape html in drilldown links (was only sanitized before)  (grafana#17731)
  Alerting: Improve alert rule testing (grafana#16286)
  Elasticsearch: Visualize logs in Explore (grafana#17605)
  Grafana-CLI: Wrapper for `grafana-cli` within RPM/DEB packages and config/homepath are now global flags (grafana#17695)
  Add guidelines for SQL date comparisons (grafana#17732)
  Docs: clarified usage of go get and go mod (grafana#17637)
  Project: Issue triage doc improvement (grafana#17709)
  Improvement: Grafana release process minor improvements (grafana#17661)
  TimePicker: New time picker dropdown & custom range UI (grafana#16811)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.