{"id":17109247,"url":"https://github.com/kevinoid/appveyor-status","last_synced_at":"2025-08-20T09:31:23.574Z","repository":{"id":17583731,"uuid":"82129749","full_name":"kevinoid/appveyor-status","owner":"kevinoid","description":"Node.js-based script and module to query AppVeyor build status via the AppVeyor REST API.","archived":false,"fork":false,"pushed_at":"2024-11-14T23:15:04.000Z","size":1328,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-15T00:23:28.184Z","etag":null,"topics":["appveyor","appveyor-api","continuous-integration","nodejs"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevinoid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-16T02:26:11.000Z","updated_at":"2024-11-14T23:15:02.000Z","dependencies_parsed_at":"2024-11-15T01:15:36.616Z","dependency_job_id":null,"html_url":"https://github.com/kevinoid/appveyor-status","commit_stats":{"total_commits":658,"total_committers":5,"mean_commits":131.6,"dds":"0.15045592705167177","last_synced_commit":"8202143cf9e056555db99651fbc149f77b5d10a4"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fappveyor-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fappveyor-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fappveyor-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fappveyor-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinoid","download_url":"https://codeload.github.com/kevinoid/appveyor-status/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230045727,"owners_count":18164343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appveyor","appveyor-api","continuous-integration","nodejs"],"created_at":"2024-10-14T16:22:36.786Z","updated_at":"2024-12-19T09:23:17.288Z","avatar_url":"https://github.com/kevinoid.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"AppVeyor Status\n===============\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/kevinoid/appveyor-status/node.js.yml?branch=main\u0026style=flat\u0026label=build)](https://github.com/kevinoid/appveyor-status/actions?query=branch%3Amain)\n[![Build Status: Windows](https://img.shields.io/appveyor/ci/kevinoid/appveyor-status/main.svg?style=flat\u0026label=build+on+windows)](https://ci.appveyor.com/project/kevinoid/appveyor-status)\n[![Coverage](https://img.shields.io/codecov/c/github/kevinoid/appveyor-status/main.svg?style=flat)](https://app.codecov.io/gh/kevinoid/appveyor-status/branch/main)\n[![Dependency Status](https://img.shields.io/librariesio/release/npm/appveyor-status.svg?style=flat)](https://libraries.io/npm/appveyor-status)\n[![Supported Node Version](https://img.shields.io/node/v/appveyor-status.svg?style=flat)](https://www.npmjs.com/package/appveyor-status)\n[![Version on NPM](https://img.shields.io/npm/v/appveyor-status.svg?style=flat)](https://www.npmjs.com/package/appveyor-status)\n\nA command-line tool and library for querying the\n[AppVeyor](https://www.appveyor.com/) build status of a project using the\nAppVeyor REST API.  It does for AppVeyor what\n[travis-status](https://github.com/kevinoid/travis-status) does for [Travis\nCI](https://travis-ci.org/).\n\n## Introductory Example\n\n### Command-Line Use\n\n    $ npm install -g appveyor-status\n    $ appveyor-status\n    AppVeyor build status: success\n\n### JavaScript Use\n\n```js\nconst appveyorStatus = require('appveyor-status');\n// See https://kevinoid.github.io/appveyor-status/api/module-appveyor-status.html#.AppveyorStatusOptions\nconst options = {\n  // By AppVeyor project name\n  // project: 'kevinoid/appveyor-status',\n  // By repository path or URL\n  // repo: 'https://github.com/kevinoid/appveyor-status.git',\n  // By statusBadgeId (from badge URL)\n  // statusBadgeId: '2fi78evfynm3wfog',\n};\nappveyorStatus.getStatus(options).then(function(status) {\n  console.log('Status of project matching git repo in cwd: ' + status);\n});\n```\n\n## Features\n\n* Can query by AppVeyor project name, webhook ID, or repository URL or path.\n* Can detect the AppVeyor project from the repository in which it is run when\n  project is not specified.\n* Can query using status badge API or project build API, minimizing latency and\n  avoiding authentication in most cases.\n* Can query most recent build for project or specific branch.\n* Can compare build commit against a named or current commit.\n* Can wait for queued build to finish, with configurable timeout, before\n  reporting status.\n\n## Installation\n\n[This package](https://www.npmjs.com/package/appveyor-status) can be\ninstalled using [npm](https://www.npmjs.com/), either globally or locally, by\nrunning:\n\n```sh\nnpm install appveyor-status\n```\n\n## Recipes\n\n### Check status before release\n\nTo check that the build for the current commit is successful before releasing\nit as a new version, add the following to `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"preversion\": \"appveyor-status -c -w\"\n  }\n}\n```\n\nThis will check that the AppVeyor status for the current repository is \"success\"\n(and will wait if queued) and that it matches the current commit.  It will\nprint the build status (which can be suppressed with `-q`) and exit with code\n0 if \"success\" and a non-zero code otherwise, which will stop the version task.\n\nAPI examples can be found in the [test\nspecifications](https://kevinoid.github.io/appveyor-status/spec).\n\n## API Docs\n\nTo use this module as a library, see the [API\nDocumentation](https://kevinoid.github.io/appveyor-status/api).\n\nCommand-line usage information is available via `--help`:\n\n```sh\nappveyor-status --help\n```\n\n## Contributing\n\nContributions are appreciated.  Contributors agree to abide by the [Contributor\nCovenant Code of\nConduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).\nIf this is your first time contributing to a Free and Open Source Software\nproject, consider reading [How to Contribute to Open\nSource](https://opensource.guide/how-to-contribute/)\nin the Open Source Guides.\n\nIf the desired change is large, complex, backwards-incompatible, can have\nsignificantly differing implementations, or may not be in scope for this\nproject, opening an issue before writing the code can avoid frustration and\nsave a lot of time and effort.\n\n## License\n\nThis project is available under the terms of the [MIT License](LICENSE.txt).\nSee the [summary at TLDRLegal](https://tldrlegal.com/license/mit-license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinoid%2Fappveyor-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinoid%2Fappveyor-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinoid%2Fappveyor-status/lists"}