Skip to content

(maint) Updating changelog generator config #1280

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

Merged

Conversation

pmcmaw
Copy link
Contributor

@pmcmaw pmcmaw commented Jun 21, 2021

Following discussion, with the HISTORY.md file formatting (## 5.3.0) the changelog generator is clever enough to pick it up as the since_tag therefore the only change made here is to remove and .github_changelog_generator file.

Copy link
Collaborator

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

I would expect to see a change in Rakefile to reflect this.

ekohl
ekohl previously approved these changes Jun 25, 2021
@pmcmaw
Copy link
Contributor Author

pmcmaw commented Jun 28, 2021

Note - failures in spec tests are unrelated to this PR.

@alexjfisher
Copy link
Collaborator

I'd recommend just fixing the formatting of line 1 of the HISTORY.MD file.
https://github.com/puppetlabs/puppetlabs-postgresql/blame/main/HISTORY.md#L1

Then since_tag will be automatically picked up.

@pmcmaw pmcmaw closed this Jun 29, 2021
@pmcmaw pmcmaw reopened this Jun 29, 2021
@DavidS
Copy link
Contributor

DavidS commented Jun 29, 2021

I'd recommend just fixing the formatting of line 1 of the HISTORY.MD file.
https://github.com/puppetlabs/puppetlabs-postgresql/blame/main/HISTORY.md#L1

Then since_tag will be automatically picked up.

Fix to what?

@alexjfisher
Copy link
Collaborator

I'd recommend just fixing the formatting of line 1 of the HISTORY.MD file.
https://github.com/puppetlabs/puppetlabs-postgresql/blame/main/HISTORY.md#L1
Then since_tag will be automatically picked up.

Fix to what?

I think just adding a release date in brackets should do it. Will have a go later.

@alexjfisher
Copy link
Collaborator

I'd recommend just fixing the formatting of line 1 of the HISTORY.MD file.
https://github.com/puppetlabs/puppetlabs-postgresql/blame/main/HISTORY.md#L1
Then since_tag will be automatically picked up.

Fix to what?

I think just adding a release date in brackets should do it. Will have a go later.

Actually, it's fine as is (without adding a date). It's already being correctly parsed from HISTORY.md.

.sync.yml Outdated
@@ -10,6 +10,7 @@ Gemfile:
- gem: github_changelog_generator
Rakefile:
changelog_user: puppetlabs
changelog_since_tag: '5.3.0'
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is actually redundant. The HISTORY.md file is formatted in such a way that this will be automatically discovered.

Rakefile Outdated
@@ -48,6 +48,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?
config.user = "#{changelog_user}"
config.project = "#{changelog_project}"
config.since_tag = "5.3.0"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line can go too.

@pmcmaw pmcmaw force-pushed the maint/main/update_changelog_config branch from be1b85d to bcc1181 Compare June 30, 2021 07:46
Copy link
Collaborator

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Yay for less code.

@sheenaajay sheenaajay merged commit fca2052 into puppetlabs:main Jul 5, 2021
cegeka-jenkins pushed a commit to cegeka/puppet-postgresql that referenced this pull request Feb 3, 2022
…gelog_config

(maint) Updating changelog generator config
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.

5 participants