bundler-site
bundler-site copied to clipboard
rubygems
Update creating_gem.en.html.md
Making a proposal to update the wiki from this issue: Issue 4458
The descriptions of the fields to complete come from Rubygems.
Mth0158
What was the end-user problem that led to this PR?
If metadata["allowed_push_host"] is not commented and you are not using your own ruby gem server you will not be able to push your gem to rubygems.org. This causes an error that is not displayed on the CLI and is very confusing.
What was your diagnosis of the problem?
The diagnosis was previously made on the issue.
What is your fix for the problem, implemented in this PR?
To explicitly write in the wiki to comment this line in gemspec file if you do not use your own gem server.
Why did you choose this fix out of the possible options?
Making the tutorial a bit more user-friendy.
It also might be a plus to change the line in the gemspec for people that skip the tutorial.
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
=> spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com' or comment this line if your are not using a gem server to push your gem"
Should we comment out this line, or even remove it? It seems like a small feature only useful for private gems that makes things more inconvenient for the rest of the world.
For what it's worth, we added this line because there was a high support load of helping people remove private gems that they didn't mean to push to rubygems.org.
It's very confusing that the error is silent, but I don't know if just letting people accidentally publish code they need our help to remove is better. 😅
Right, I missed that context. Suggestion retired then :)
I think changing the line from http://mygemserver.com to https://mygemserver.com might do the trick, then?
Hmmm.... maybe we could make the private config line an option? "DO YOU WANT ALL GEMS YOU MAKE TO BE PUBLIC Y/N IF YOU DO THIS WE WILL NOT HELP YOU WHEN YOU ACCIDENTALLY PUBLISH YOUR COMPANY'S PRIVATE CODE" 😅
@indirect A setting to configure whether to generate the allowed_push_host setting or not sounds good to me! But using https in the current placeholder would also alleviate the issue in any case, and is straightforward, so I would start with that.
Hi @Mth0158. In #625, I moved the target file source/localizable/v2.2/guides/creating_gem.en.html.md to source/localizable/guides/creating_gem.en.html.md, so could you mind updating your change? You can do it just move the file to source/localizable/guides.
@Mth0158 Could you address file conflicts to get this ready? 🙏 This is a friendly reminder.