badges/shields

Badge request: From AppVeyor build artifact

Open

#555 opened on Nov 2, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

I'd like to display badges based on the contents of an AppVeyor build's artifact files. The build would drop special text files which AppVeyor would report as artifacts. These text files would contain just one line of text:

<SUBJECT>-<STATUS>-<COLOR>

The artifact filenames would follow some agreed upon convention such as SOMENAME.shield.

The shield could then be displayed via a URL like this: https://img.shields.io/appveyor/ci-artifact/USERNAME/PROJECT/SOMENAME.svg

See https://github.com/AArnott/pinvoke/issues/24 for a full description of what we want to create.

Contributor guide

Tech stack
javascriptrest api
Domain
backendapidevops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js knowledgeShields badge architectureAppVeyor CI concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine existing badge service implementations in the codebase (e.g., services/travis.js, services/circleci.js) to understand the pattern. Review the AppVeyor API documentation for build artifacts at https://www.appveyor.com/docs/api/#build artifacts. The new endpoint should be created in the services directory following the same structure. Check the linked issue at https://github.com/AArnott/pinvoke/issues/24 for additional context.