diff --git a/.github/ISSUE_TEMPLATE/3_Badge_request.md b/.github/ISSUE_TEMPLATE/3_Badge_request.md deleted file mode 100644 index 01dfdc67ae50a631f3b9b96d61d6bce20d5bddf8..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/3_Badge_request.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: 💡 Badge Request -about: Ideas for new badges -labels: 'service-badge' ---- - -:clipboard: **Description** - -<!-- -A clear and concise description of the new badge. - -- Which service is this badge for e.g: GitHub, Travis CI -- What sort of information should this badge show? - Provide an example in plain text e.g: "version | v1.01" or as a static badge - (static badge generator can be found at https://shields.io) ---> - -:link: **Data** - -<!-- -Where can we get the data from? - -- Is there a public API? -- Does the API require an API key? -- Link to the API documentation. ---> - -:microphone: **Motivation** - -<!-- -Please explain why this feature should be implemented and how it would be used. - -- What is the specific use case? ---> - -<!-- Love Shields? Please consider donating $10 to sustain our activities: -👉 https://opencollective.com/shields --> diff --git a/.github/ISSUE_TEMPLATE/3_Badge_request.yml b/.github/ISSUE_TEMPLATE/3_Badge_request.yml new file mode 100644 index 0000000000000000000000000000000000000000..af72465f561571d3c9658caa3404c0bdc3cbb1a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_Badge_request.yml @@ -0,0 +1,62 @@ +name: '💡 Badge Request' +description: Ideas for new badges +labels: ['service-badge'] +body: + - type: markdown + attributes: + value: > + ## Ideas for new badges + + + This issue template is for suggesting new badges which + **fetch and display data from an upstream service**. + If your suggestion is for a static badge + (which shows the same information every time it is requested), it is + [already possible to make these](https://github.com/badges/shields/blob/master/doc/static-badges.md). + We don't add specific routes for badges which only show static information. + + - type: textarea + id: description + attributes: + label: '📋 Description' + description: | + A clear and concise description of the new badge. + + - Which service is this badge for e.g: GitHub, Travis CI + - What sort of information should this badge show? + Provide an example in plain text e.g: "version | v1.01" or as a static badge + (static badge generator can be found at https://shields.io/#your-badge ) + validations: + required: true + + - type: textarea + id: data + attributes: + label: '🔗 Data' + description: | + Where can we get the data from? + + Please consider and cover details like: + - Is there a public API? + - Does the API require authentication or an API key? + If so, please review our documentation on [Badges Requiring Authentication](https://github.com/badges/shields/blob/master/doc/authentication.md) + - Link to the API documentation. + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: '🎤 Motivation' + description: | + Please explain why this feature should be implemented and how it would be used. + + - What is the specific use case? + validations: + required: true + + - type: markdown + attributes: + value: | + ## :heart: Love Shields? + Please consider donating $10 to sustain our activities: [https://opencollective.com/shields](https://opencollective.com/shields) diff --git a/doc/authentication.md b/doc/authentication.md new file mode 100644 index 0000000000000000000000000000000000000000..1e0b5f9a445e2a2802af14417969b3d10b528a71 --- /dev/null +++ b/doc/authentication.md @@ -0,0 +1,8 @@ +# Badges Requiring Authentication + +There are two patterns for how shields.io can interact with APIs that require auth: + +1. We can store one token at the service level which allows us to read public data for everyone's projects, or lift a rate limit. If you are looking for information on configuring credentials for a self-hosted instance see https://github.com/badges/shields/blob/master/doc/server-secrets.md +2. If every user needs to provide their own token, that has to be a token which can be passed to us as a query param in the badge URL. This means it must be possible to generate a key or token that can be exposed in a public github README public with no negative consequences. (i.e: that key or token only exposes public metrics). + +If every user would need to supply their own token for some particular service and it is only possible to generate a key or token which allows access to sensitive data or allows write access to resources, we can't provide an integration for this service. diff --git a/doc/logos.md b/doc/logos.md index c408b79aef9b33abf0b9e774d22aad13fb5d3fc3..48617b7111d78eefedf606384ab6d7c47aab4420 100644 --- a/doc/logos.md +++ b/doc/logos.md @@ -22,6 +22,18 @@ Any custom logo can be passed in a URL parameter by base64 encoding it. e.g:  - https://img.shields.io/badge/play-station-blue.svg?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEiIHdpZHRoPSI2MDAiIGhlaWdodD0iNjAwIj48cGF0aCBkPSJNMTI5IDExMWMtNTUgNC05MyA2Ni05MyA3OEwwIDM5OGMtMiA3MCAzNiA5MiA2OSA5MWgxYzc5IDAgODctNTcgMTMwLTEyOGgyMDFjNDMgNzEgNTAgMTI4IDEyOSAxMjhoMWMzMyAxIDcxLTIxIDY5LTkxbC0zNi0yMDljMC0xMi00MC03OC05OC03OGgtMTBjLTYzIDAtOTIgMzUtOTIgNDJIMjM2YzAtNy0yOS00Mi05Mi00MmgtMTV6IiBmaWxsPSIjZmZmIi8+PC9zdmc+ +### logoColor parameter + +The `logoColor` param can be used to set the color of the logo. Hex, rgb, rgba, hsl, hsla and css named colors can all be used. For SimpleIcons named logos (which are monochrome), the color will be applied to the SimpleIcons logo. + +-  - https://img.shields.io/badge/logo-javascript-blue?logo=javascript +-  - https://img.shields.io/badge/logo-javascript-blue?logo=javascript&logoColor=f5f5f5 + +In the case where Shields hosts a custom multi-colored logo, if the `logoColor` param is passed, the corresponding SimpleIcons logo will be substituted and colored. + +-  - https://img.shields.io/badge/logo-gitlab-blue?logo=gitlab +-  - https://img.shields.io/badge/logo-gitlab-blue?logo=gitlab&logoColor=white + ## Contributing Logos Our preferred way to consume icons is via the SimpleIcons logo. As a first port of call, we encourage you to contribute logos to [the SimpleIcons project][simple-icons github]. Please review their [guidance](https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md) before contributing. diff --git a/doc/static-badges.md b/doc/static-badges.md new file mode 100644 index 0000000000000000000000000000000000000000..75d9df2f45c356f1c95d976801b7fb8758a8e708 --- /dev/null +++ b/doc/static-badges.md @@ -0,0 +1,12 @@ +# Static Badges + +It is possible to use shields.io to make a wide variety of badges displaying static text and/or logos. For example: + +-  - https://img.shields.io/badge/any%20text-you%20like-blue +-  - https://img.shields.io/badge/just%20the%20message-8A2BE2 +-  - https://img.shields.io/badge/%27for%20the%20badge%27%20style-20B2AA?style=for-the-badge +-  - https://img.shields.io/badge/with%20a%20logo-grey?style=for-the-badge&logo=javascript + +Full documentation of styles and parameters: https://shields.io/#styles + +More documentation on logos: https://github.com/badges/shields/blob/master/doc/logos.md