Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix CircleCI token example #2373

Merged
merged 2 commits into from
Nov 20, 2018
Merged

Fix CircleCI token example #2373

merged 2 commits into from
Nov 20, 2018

Conversation

haythem
Copy link
Contributor

@haythem haythem commented Nov 19, 2018

The CircleCI token example contains a redundant fragment /circleci/circleci/:token.

In addition, I think that you should allow a comment or a hint to be associated with the example or the provider at least to guide the user especially with private repositories.

For instance, in CircleCI, there are 3 token scopes :

  1. status used for build status
  2. view-builds for downloading artifacts
  3. all to grant full read access to the project

Although it might seem that the first type is the one that should be used with the badge, the badge will not render unless an all scope token is specified.

@shields-ci
Copy link

Warnings
⚠️ This PR modified service code for circleci but not its test code.
That's okay so long as it's refactoring existing code.
Messages
📖 ✨ Thanks for your contribution to Shields, @haythem!

Generated by 🚫 dangerJS

@paulmelnikow
Copy link
Member

Fabulous, thank you!

Agreed the permissions issue should be documented until it's fixed. (#1064)

Would you like to add the documentation? If you put a documentation key in the badge examples containing HTML it'll render on the badge popup. Here's an example: https://github.com/badges/shields/blob/master/services/appveyor/appveyor-tests.service.js

@paulmelnikow paulmelnikow added the service-badge New or updated service badge label Nov 20, 2018
@paulmelnikow paulmelnikow merged commit ce0b492 into badges:master Nov 20, 2018
@shields-deployment
Copy link

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

@haythem
Copy link
Contributor Author

haythem commented Nov 20, 2018

Thanks @paulmelnikow for merging the PR.

Would you like to add the documentation ?

Yeah, sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
service-badge New or updated service badge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants