Display latest version in header

[jekyllbot]

PR automatically created for @DirtyF.

Display latest version in header

[DirtyF]

I don't like to have to update the config file manually at each release, any way to add this to our rake release task?

[ashmaroli]

jekyll/rake/site.rake

Lines 87 to 90 in 5ef2deb

	desc "Write the site latest_version.txt file"
	task :version_file do
	File.open("#{docs_folder}/latest_version.txt", "wb") { |f| f.puts(version) } unless version =~ %r!(beta|rc|alpha)!i
	end

[DirtyF]

@ashmaroli yeah I was thinking of something similar: a task that parses docs/_config.yml and replace the version value. 😄

[ashmaroli]

yes, that's the way to do it.. I just pointed you to where to add the code..
Do you want me to push to this branch or just paste the code here..?

[DirtyF]

@ashmaroli as you like (I was going to try to learn how to parse a yml file in Ruby, but I 'm sure you'll be quicker at this). Thanks for your help.

[ashmaroli]

This is the updated block for above snippet.. I'll leave it to you to update the task name(s) and description and test locally .. 😉 😁

  desc "Write the site latest_version.txt file"
  task :version_file do
    return if version =~ %r!(beta|rc|alpha)!i
    config_file = File.join(docs_folder, "_config.yml")
    contents = File.read(config_file)
    File.write(config_file, contents.sub(/(?:version\s*:\s+)(.+)/, "version: #{version}"))
  end

[DirtyF]

@ashmaroli thanks, works like a charm 👍

[ashmaroli]

How about..?

- "Write the site latest version"
+ "Write the latest Jekyll version used to generate the site"

[DirtyF]

I kept the beginning of your suggestion to keep it short

[ashmaroli]

okay.. I'll let the others review the changes..
If you (and the others) feel like taking the task to another level, the following patch should insert the version data if its ever removed..

  desc "Write the latest Jekyll version"
  task :latest_version do
    return if version =~ %r!(beta|rc|alpha)!i
    config_file   = File.join(docs_folder, "_config.yml")
    contents      = File.read(config_file)
    version_regex = /(?:version\s*:\s+)(.+)/

    if contents =~ version_regex
      File.write(config_file, contents.sub(version_regex, "version: #{version}"))
    else
      File.open(config_file, "a+") do |file|
        file.puts <<-TXT

# latest docs version displayed in the header
# inserted and updated automatically by the following rake task(s)
#   bundle exec rake site:preview
#   bundle exec rake site:latest_version
version: #{version}"
TXT
      end
    end
  end

[DirtyF]

@jekyllbot: merge +site

[Crunch09]

@DirtyF @ashmaroli ❤️ thanks for fixing this so quickly!
A nicer alternative might be:

require 'safe_yaml/load'
config = SafeYAML.load_file(config_file)
config["version"] = version
File.write(config_file, YAML.dump(config))

so we don't have to use a regex, but just a suggestion as it is already merged and works fine!

[DirtyF]

@Crunch09 👍 that's exactly what I was thinking about, I like it DRY. I even thought we could use a Jekyll class to read the config file.

Feel free to open a PR and I'll merge it 😄

[ashmaroli]

A nicer alternative might be:

Wow @Crunch09, That is sooo much better..!! ( Why didn't I think of that!! 😄 )