Update creating_gem.en.html.md #579
Conversation
Making a proposal to update the wiki from this issue: rubygems/rubygems#4458 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. The descriptions of the fields to complete come from Rubygems. Mth0158
|
It also might be a plus to change the line in the gemspec for people that skip the tutorial.
=> |
| * *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo | ||
| * *metadata["allowed_push_host"]:* The field allows you to restrict gem pushes to a single host. If you are not running your own gem server you should comment this line, otherwise you will not be able to push your gem to rubygems.org. | ||
| * *metadata["source_code_uri"]:* The URL of your gem's public repo | ||
| * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md |
There was a problem hiding this comment.
| * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md | |
| * `metadata["changelog_uri"]`: The URL of your gem's CHANGELOG.md. |
| * *description (optional):* A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | ||
| * *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo | ||
| * *metadata["allowed_push_host"]:* The field allows you to restrict gem pushes to a single host. If you are not running your own gem server you should comment this line, otherwise you will not be able to push your gem to rubygems.org. | ||
| * *metadata["source_code_uri"]:* The URL of your gem's public repo |
There was a problem hiding this comment.
| * *metadata["source_code_uri"]:* The URL of your gem's public repo | |
| * `metadata["source_code_uri"]`: The URL of your gem's public repo. |
| * Fields to complete: | ||
| * *summary:* A short summary of your gem's description. | ||
| * *description (optional):* A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | ||
| * *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo |
There was a problem hiding this comment.
| * *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo | |
| * `homepage`: The URL of your gem's home page, it can be the URL of its website or public repo. |
| @@ -83,6 +83,13 @@ extension and the _.bundle_ directory. | |||
| * **foodie.gemspec**: The Gem Specification file. This is | |||
| where we provide information for Rubygems' consumption such as the name, description and homepage | |||
| of our gem. This is also where we specify the dependencies our gem needs to run. | |||
| * Fields to complete: | |||
| * *summary:* A short summary of your gem's description. | |||
| * *description (optional):* A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | |||
There was a problem hiding this comment.
| * *description (optional):* A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | |
| * `description` (optional): A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. |
| @@ -83,6 +83,13 @@ extension and the _.bundle_ directory. | |||
| * **foodie.gemspec**: The Gem Specification file. This is | |||
| where we provide information for Rubygems' consumption such as the name, description and homepage | |||
| of our gem. This is also where we specify the dependencies our gem needs to run. | |||
| * Fields to complete: | |||
| * *summary:* A short summary of your gem's description. | |||
There was a problem hiding this comment.
| * *summary:* A short summary of your gem's description. | |
| * `summary`: A short summary of your gem's description. |
| * *summary:* A short summary of your gem's description. | ||
| * *description (optional):* A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | ||
| * *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo | ||
| * *metadata["allowed_push_host"]:* The field allows you to restrict gem pushes to a single host. If you are not running your own gem server you should comment this line, otherwise you will not be able to push your gem to rubygems.org. |
There was a problem hiding this comment.
running your own gem server
That's really advanced stuff for beginner. Is there any chance to reword this to make it clear by allowing rubygems.org you'll be able to push to public (accessible by everyone) repository and this is needed for this guide to be able to publish in the end?
|
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 |
|
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 |
|
Great, let’s do it. 🙂 |
|
Done @tnir ✌🏼 |
| * *metadata["source_code_uri"]:* The URL of your gem's public repo | ||
| * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md |
There was a problem hiding this comment.
Cool addition.
Here's a small tweak:
| * *metadata["source_code_uri"]:* The URL of your gem's public repo | |
| * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md | |
| * *metadata["source_code_uri"]:* The URL of your gem's public repo. | |
| * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG. |
- Ending sentences in a period.
- Avoiding deciding on what file format a changelog has.
|
@Mth0158 Could you address file conflicts to get this ready? 🙏 |
|
@Mth0158 Could you address file conflicts to get this ready? 🙏 |
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.