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

docs(git): add changelog #765

Merged
merged 1 commit into from
Mar 20, 2019
Merged

Conversation

njhale
Copy link
Member

@njhale njhale commented Mar 19, 2019

After some digging, I noticed that projects like etcd and kubernetes make use of a CHANGELOG.md file as the primary source of info for GH releases. Some supplemental googling lead to a wealth of info on the matter (https://keepachangelog.com/en/1.0.0/ and https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md) and even a tool for generating changelogs.

This PR contains the output of github-changelog-generator - Let me know if we can use this as-is, or if the output needs to be better curated.

@openshift-ci-robot openshift-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 19, 2019
@njhale
Copy link
Member Author

njhale commented Mar 19, 2019

Also, the tool used to generate this assigns content to a header based on labels. This means that we can label merged PRs with labels such as "bug" and they will be listed under the "Fixed Bugs" header. It also has options for custom headers and tags.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@ecordell ecordell added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 19, 2019
@njhale njhale added docs and removed kind/feature Categorizes issue or PR as related to a new feature. labels Mar 19, 2019
Copy link
Member

@alecmerdler alecmerdler left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 19, 2019
@openshift-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alecmerdler, njhale

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

@njhale
Copy link
Member Author

njhale commented Mar 19, 2019

/retest

@ecordell
Copy link
Member

ecordell commented Mar 19, 2019 via email

@openshift-ci-robot
Copy link
Collaborator

New changes are detected. LGTM label has been removed.

@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Mar 20, 2019
@njhale
Copy link
Member Author

njhale commented Mar 20, 2019

/retest

1 similar comment
@njhale
Copy link
Member Author

njhale commented Mar 20, 2019

/retest

@openshift-ci-robot
Copy link
Collaborator

@njhale: The following tests failed, say /retest to rerun them all:

Test name Commit Details Rerun command
ci/prow/e2e-aws-olm 4706c77 link /test e2e-aws-olm
ci/prow/e2e-aws 4706c77 link /test e2e-aws

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@njhale njhale merged commit ef6f544 into operator-framework:master Mar 20, 2019
@njhale njhale deleted the add-changelog branch September 30, 2019 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. docs size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants