Skip to content

Accept an optional workdir to render changelog #41

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Accept an optional workdir to render changelog #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f201252
Accept an optional workdir to render changelog
Apr 25, 2025
9e940f5
Pull workdir & clean settings to cmdline options
Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/chef/knife/changelog.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,22 @@ class Changelog < Knife
boolean: true,
default: false

option :workdir,
long: '--workdir PATH',
description: 'Path used to fetch cookbook sources & render changelog'

option :cleanup,
long: '--cleanup',
boolean: true,
description: 'Remove cookbook sources after changelog generation'

def run
Log.info config.to_s
puts PolicyChangelog.new(
@name_args,
config[:policyfile],
config[:with_dependencies]
).generate_changelog(prevent_downgrade: config[:prevent_downgrade])
).generate_changelog(prevent_downgrade: config[:prevent_downgrade], work_dir: config[:workdir], clean_work_dir: config[:cleanup])
end
end
end
Expand Down
11 changes: 7 additions & 4 deletions lib/knife/changelog/policyfile.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,12 @@ def validate_downgrade!(data)
# Generates Policyfile changelog
#
# @return [String] formatted version changelog
def generate_changelog(prevent_downgrade: false)
::Dir.mktmpdir(TMP_PREFIX) do |dir|
def generate_changelog(prevent_downgrade: false, work_dir: nil, clean_work_dir: true)
work_dir ||= ::Dir.mktmpdir(TMP_PREFIX)
begin
lock_current = read_policyfile_lock(@policyfile_dir)
current = versions(lock_current['cookbook_locks'], 'current')
lock_target = update_policyfile_lock(work_dir: dir)
lock_target = update_policyfile_lock(work_dir: work_dir)
target = versions(lock_target['cookbook_locks'], 'target')
updated_cookbooks = current.deep_merge(target).reject { |_name, data| reject_version_filter(data) }
changelog_cookbooks = if @with_dependencies || @cookbooks_to_update.nil?
Expand All @@ -226,7 +227,9 @@ def generate_changelog(prevent_downgrade: false)
updated_cookbooks.select { |name, _data| @cookbooks_to_update.include?(name) }
end
validate_downgrade!(updated_cookbooks) if prevent_downgrade
generate_changelog_from_versions(changelog_cookbooks, work_dir: dir)
generate_changelog_from_versions(changelog_cookbooks, work_dir: work_dir)
ensure
FileUtils.remove_entry work_dir if clean_work_dir
end
end

Expand Down