summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2016-11-07 19:03:35 -0800
committerTim Smith <tsmith@chef.io>2016-11-07 19:03:35 -0800
commita60fe0bfc7c8f495195acde5654ff63bf0535960 (patch)
tree246056509dd3b3559477f42fd36d1ed045072cf7
parent1d61e460675a540536bd4fc893b4bc6aa7070f21 (diff)
downloadchef-changelog_header.tar.gz
Add gem release badge to the readme / changelog headerchangelog_header
When we update our changelog it’s a bit confusing since multiple days go by before we ship the new release. Adding a header to the changelog and a readme gem release badge should help clear up what our current release actually is. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--README.md3
-rw-r--r--tasks/changelog.rb1
2 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 99f2ba4063..db647f65eb 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
[![Code Climate](https://codeclimate.com/github/chef/chef.svg)](https://codeclimate.com/github/chef/chef)
[![Build Status Master](https://travis-ci.org/chef/chef.svg?branch=master)](https://travis-ci.org/chef/chef)
[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/chef?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/chef/branch/master)
+[![Gem Version](https://badge.fury.io/rb/chef.svg)](https://badge.fury.io/rb/chef)
Want to try Chef? Get started with [learnchef](https://learn.chef.io)
@@ -76,7 +77,7 @@ The general development process is:
master.
Once your repository is set up, you can start working on the code. We do utilize
-RSpec for test driven development, so you'll need to get a development
+RSpec for test driven development, so you'll need to get a development
environment running. Follow the above procedure ("Installing from Git") to get
your local copy of the source running.
diff --git a/tasks/changelog.rb b/tasks/changelog.rb
index 6dd1ba58ae..c710409345 100644
--- a/tasks/changelog.rb
+++ b/tasks/changelog.rb
@@ -19,6 +19,7 @@ begin
config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature".split(",")
config.bug_labels = "bug,Bug,Improvement,Upstream Bug".split(",")
config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Discussion".split(",")
+ config.header = "This changelog reflects the current state of chef's master branch on github and may not reflect the current released version of chef, which is [![Gem Version](https://badge.fury.io/rb/chef.svg)](https://badge.fury.io/rb/chef)"
end
task :changelog do