Skip to content
This repository was archived by the owner on Apr 14, 2021. It is now read-only.

[CLI::GEM] bundle gem will generate homepage_uri and code and changelog section …#6697

Merged
bundlerbot merged 1 commit intorubygems:masterfrom
walf443:added_changelog_section
Sep 14, 2018
Merged

[CLI::GEM] bundle gem will generate homepage_uri and code and changelog section …#6697
bundlerbot merged 1 commit intorubygems:masterfrom
walf443:added_changelog_section

Conversation

@walf443
Copy link
Copy Markdown
Contributor

@walf443 walf443 commented Sep 12, 2018

What was the end-user problem that led to this PR?

The problem was I always have to remember how to add CHANGELOG.md when I set up a new gem.

What was your diagnosis of the problem?

My diagnosis was that CHANGELOG.md has become enough of a community standard that it makes sense to offer it in bundle gem.

What is your fix for the problem, implemented in this PR?

My fix is only added metadata[:changelog_uri] to generated gemspec file.
Changelog.md file is not generated by default.

Why did you choose this fix out of the possible options?

I chose this fix because Changelog.md file format is different by projects.

@ghost
Copy link
Copy Markdown

ghost commented Sep 12, 2018

Thanks for opening a pull request and helping make Bundler better! Someone from the Bundler team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use Travis CI to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of Travis CI in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #bundler channel on Slack.

For more information about contributing to the Bundler project feel free to review our CONTRIBUTING guide

@walf443
Copy link
Copy Markdown
Contributor Author

walf443 commented Sep 12, 2018

rubygems link in changelog_uri was introduced by https://github.com/rubygems/rubygems.org/pull/1553/files

Copy link
Copy Markdown
Contributor

@greysteil greysteil left a comment

Choose a reason for hiding this comment

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

Makes a lot of sense to me - thanks for the contribution! I'll leave open for 24 hours for others to chime in on, and merge if no-one has any other feedback.

@walf443
Copy link
Copy Markdown
Contributor Author

walf443 commented Sep 12, 2018

oh. I'll try to fix test.

@hsbt hsbt self-assigned this Sep 12, 2018
@hsbt
Copy link
Copy Markdown
Member

hsbt commented Sep 12, 2018

@walf443 Thanks. I will merge this after test passes.

@walf443 walf443 force-pushed the added_changelog_section branch from bbda404 to e6a64de Compare September 14, 2018 03:32
@walf443 walf443 force-pushed the added_changelog_section branch from e6a64de to f78645d Compare September 14, 2018 04:57
@walf443
Copy link
Copy Markdown
Contributor Author

walf443 commented Sep 14, 2018

@hsbt I'm sorry to be late to fix test.

@hsbt
Copy link
Copy Markdown
Member

hsbt commented Sep 14, 2018

@bundlerbot r+

@bundlerbot
Copy link
Copy Markdown
Collaborator

📌 Commit f78645d has been approved by hsbt

@bundlerbot
Copy link
Copy Markdown
Collaborator

⌛ Testing commit f78645d with merge c7ed6a2...

bundlerbot added a commit that referenced this pull request Sep 14, 2018
[CLI::GEM] bundle gem will generate homepage_uri and code and changelog section …

### What was the end-user problem that led to this PR?

The problem was I always have to remember how to add CHANGELOG.md  when I set up a new gem.

### What was your diagnosis of the problem?

My diagnosis was that CHANGELOG.md has become enough of a community standard that it makes sense to offer it in bundle gem.

### What is your fix for the problem, implemented in this PR?

My fix is only added metadata[:changelog_uri] to generated gemspec file.
Changelog.md file is not generated by default.

### Why did you choose this fix out of the possible options?

I chose this fix because Changelog.md file format is different by projects.
@bundlerbot
Copy link
Copy Markdown
Collaborator

☀️ Test successful - status-travis
Approved by: hsbt
Pushing c7ed6a2 to master...

@bundlerbot bundlerbot merged commit f78645d into rubygems:master Sep 14, 2018
@colby-swandale colby-swandale added this to the 1.17.1 milestone Sep 24, 2018
colby-swandale pushed a commit that referenced this pull request Oct 5, 2018
[CLI::GEM] bundle gem will generate homepage_uri and code and changelog section …

### What was the end-user problem that led to this PR?

The problem was I always have to remember how to add CHANGELOG.md  when I set up a new gem.

### What was your diagnosis of the problem?

My diagnosis was that CHANGELOG.md has become enough of a community standard that it makes sense to offer it in bundle gem.

### What is your fix for the problem, implemented in this PR?

My fix is only added metadata[:changelog_uri] to generated gemspec file.
Changelog.md file is not generated by default.

### Why did you choose this fix out of the possible options?

I chose this fix because Changelog.md file format is different by projects.

(cherry picked from commit c7ed6a2)
colby-swandale pushed a commit that referenced this pull request Oct 5, 2018
[CLI::GEM] bundle gem will generate homepage_uri and code and changelog section …

### What was the end-user problem that led to this PR?

The problem was I always have to remember how to add CHANGELOG.md  when I set up a new gem.

### What was your diagnosis of the problem?

My diagnosis was that CHANGELOG.md has become enough of a community standard that it makes sense to offer it in bundle gem.

### What is your fix for the problem, implemented in this PR?

My fix is only added metadata[:changelog_uri] to generated gemspec file.
Changelog.md file is not generated by default.

### Why did you choose this fix out of the possible options?

I chose this fix because Changelog.md file format is different by projects.

(cherry picked from commit c7ed6a2)
colby-swandale pushed a commit that referenced this pull request Oct 7, 2018
* 1-16-stable:
  Version 1.16.6 with changelog
  fix uninitialized @use_gvp instance var warning
  no longer test Ruby 1.9.3 against rubygems master
  Merge #6708
  Auto merge of #6697 - walf443:added_changelog_section, r=hsbt
  Merge #6687
  Merge #6686
  Auto merge of #6670 - bundler:colby/invite-stephanie-morillo, r=segiddins
  Auto merge of #6627 - agrim123:agr-fix-add-groups, r=deivid-rodriguez
  Auto merge of #6612 - hdf1986:readme-bundle-add, r=segiddins
  Auto merge of #6495 - bundler:segiddins/6491-extra-gem-platform-in-lockfile, r=segiddins
  Auto merge of #6493 - agrim123:agr-update-bundle-update-docs, r=colby-swandale
  Auto merge of #6310 - utilum:rescue_unspecified_exception, r=segiddins
  Auto merge of #6184 - arbonap:pa-check-in-gemfile-docs, r=indirect
  fix typo
@kbrock
Copy link
Copy Markdown

kbrock commented Nov 5, 2018

@walf443 Thank you so much for putting together this PR.

/cc @olivierlacan not sure if you saw this

@olivierlacan
Copy link
Copy Markdown
Contributor

olivierlacan commented Nov 5, 2018

@kbrock I did in a new gem I built. It's awesome! Although I was a bit confused that the block appeared wrapped in the RubyGems.org push prevention conditional at first because of the comment location. Seems like that might confuse some folks into deleting the whole conditional block:

  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
  # to allow pushing to a single host or delete this section to allow pushing to any host.
  if spec.respond_to?(:metadata)
    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

    spec.metadata["homepage_uri"] = spec.homepage
    spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
  else
    raise "RubyGems 2.0 or newer is required to protect against " \
      "public gem pushes."
  end

I think I might submit a PR to address that if it makes sense.

Edit: Looks like @deivid-rodriguez's already taken care of that in 6a0da62. Thanks Deivid!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants