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

Do not raise if source_code_uri is missing in the gemspec #163

Merged
merged 1 commit into from
Jan 14, 2021

Conversation

kennyadsl
Copy link
Member

Summary

That metadata is useful to automatically generate the CHANGELOG based on GitHub activity, using Oktokit and github_changelog_generator.

But a lot of extensions do not have that metadata set. We can be more kind by not making specs ran with rake (which are unrelated) fail when that information is missing.

This is the output when that metadata is missing after this PR will be merged:

$ bundle exec rake
It won't be possible to automatically generate the CHANGELOG for this extension because the
gemspec is missing the `source_code_uri` metadata. Please add this line to the gemspec to
enable automatic CHANGELOG generation:

    s.metadata["source_code_uri"] = 'https://github.com/org/repo'

Refs:

Checklist

  • I have structured the commits for clarity and conciseness.
  • I have added relevant automated tests for this change.

That metadata is useful to automatically generate the CHANGELOG
based on GitHub activity, using Oktokit and github_changelog_generator.

But a lot of extensions do not have that metadata set. We can be more
kind by not making specs ran with rake (which are unrelated) fail when
that information is missing.
@kennyadsl kennyadsl self-assigned this Jan 14, 2021
@mergify
Copy link
Contributor

mergify bot commented Jan 14, 2021

It looks like this PR is missing a label to determine the type of change it introduces. The maintainer should add one of the following labels:

  • bug for bugfixes.
  • enhancement for new features and improvements.
  • documentation for documentation changes.
  • security for security patches.
  • removed for feature removals.
  • infrastructure for internal changes that should not go in the changelog.

Additionally, the maintainer may also want to add one of the following:

  • breaking for breaking changes.
  • deprecated for feature deprecations.

Once the correct labels have been set, simply remove the needs changelog label label from this PR so I can merge it.

@mergify mergify bot added the needs changelog label Needs a label to determine the type of change. label Jan 14, 2021
Copy link
Member

@aldesantis aldesantis left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@aldesantis aldesantis added enhancement Improves an existing feature. and removed needs changelog label Needs a label to determine the type of change. labels Jan 14, 2021
@mergify mergify bot merged commit 329e370 into master Jan 14, 2021
@mergify mergify bot deleted the kennyadsl/avoid-raise-changelog branch January 14, 2021 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improves an existing feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants