Add maximum gem metadata size limit to GitHub Package RubyGems Registry documentation (#35797)

Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
gitulisca 2023-03-24 19:34:42 +11:00 коммит произвёл GitHub
Родитель 524b5a8614
Коммит 3fa5a2a3f5
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 8 добавлений и 0 удалений

Просмотреть файл

@ -98,6 +98,12 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els
```
1. Publish a package to {% data variables.product.prodname_registry %}, replacing `NAMESPACE` with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the package will be scoped{% else %}that owns the repository containing your project{% endif %} and `GEM_NAME` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY_URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace `HOSTNAME` with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %} Replace `REGISTRY_URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace `HOSTNAME` with the hostname of {% data variables.location.product_location %}.{% endif %}
{% note %}
**Note:** The maximum uncompressed size of a gem's `metadata.gz` file must be less than {% data variables.package_registry.limit_rubygems_max_metadata_size %}. Requests to push gems that exceed that limit will fail.
{% endnote %}
```
$ gem push --key github \
--host https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE \

Просмотреть файл

@ -3,3 +3,5 @@ package-settings-actions-access-menu: >-
{% ifversion ghes or ghae %}through the **Actions access** menu option{% else %}by using the **Add Repository** button under "Manage Actions access" in the package's settings{% endif %}
package-settings-actions-access-role-dropdown: >-
the **Role** drop-down menu to select the default access level that you'd like the repository to have to your package.
# packages registries limits
limit_rubygems_max_metadata_size: '2 MB'