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

CHANGELOG: Add #693

Merged
merged 3 commits into from
Aug 29, 2018
Merged

CHANGELOG: Add #693

merged 3 commits into from
Aug 29, 2018

Conversation

gaocegege
Copy link
Member

@gaocegege gaocegege commented Jun 22, 2018

I think we should maintain a change log for users. This is generated by https://github.com/github-changelog-generator/github-changelog-generator

github_changelog_generator -t  _____ -u kubeflow -p tf-operator --exclude-labels community/discussion,cmmunity/question,duplicate,question,invalid,wontfix --bug-labels kind/bug,problems/bug --enhancement-labels improvement/optimization,kind/enhancement,improvement/enhancement,addition/feature,kind/feature --enhancement-label "**Features and improvements:**"

Signed-off-by: Ce Gao gaoce@caicloud.io


This change is Reviewable

@coveralls
Copy link

coveralls commented Jun 22, 2018

Coverage Status

Coverage remained the same at 57.992% when pulling 8bb5745 on gaocegege:changelog into 04de8a1 on kubeflow:master.

@gaocegege
Copy link
Member Author

/assign @jlewi

@jlewi
Copy link
Contributor

jlewi commented Jun 28, 2018

Can you put the relevant command in a script and add instructions somewhere so its easy for people to redo?

This is certainly an improvement over the current situation but it looks like the changelog will need further refinement to make it truly useful.

I wonder if we should follow the approach of explicitly requiring PR descriptions to include text that will be included in the changelog.

@gaocegege
Copy link
Member Author

OK, I will do it soon.

@jlewi
Copy link
Contributor

jlewi commented Jul 27, 2018

@gaocegege Just a reminder this is still pending. I think this would be useful and hopeful its not much additional work to make the requested changes.

@jlewi jlewi closed this Jul 27, 2018
@jlewi jlewi reopened this Jul 27, 2018
@gaocegege
Copy link
Member Author

@jlewi Sorry for the late reply, I will try to finish the task these days.

Signed-off-by: Ce Gao <gaoce@caicloud.io>
Signed-off-by: Ce Gao <gaoce@caicloud.io>
Signed-off-by: Ce Gao <gaoce@caicloud.io>
@gaocegege
Copy link
Member Author

It is hard to add PR description into the changelog using the existing tool. And I think it is redundant. We use the tool to generate accurate CHANGELOG, while we should not use it as release note for Kubeflow tf-operator. Thus personally, I think it works for me.

WDYT @jlewi

@gaocegege
Copy link
Member Author

/retest

@jlewi
Copy link
Contributor

jlewi commented Aug 29, 2018

/lgtm
/approve

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlewi

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:

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

@k8s-ci-robot k8s-ci-robot merged commit e63ea46 into kubeflow:master Aug 29, 2018
@gaocegege gaocegege deleted the changelog branch August 30, 2018 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants