{"id":16363907,"url":"https://github.com/axelrindle/github-version-checker","last_synced_at":"2025-03-23T02:31:59.892Z","repository":{"id":24278967,"uuid":"86911040","full_name":"axelrindle/github-version-checker","owner":"axelrindle","description":"🔍 Simple version checker working with GitHub releases and the GitHub API.","archived":false,"fork":false,"pushed_at":"2023-07-04T21:13:16.000Z","size":2017,"stargazers_count":8,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-26T13:31:19.048Z","etag":null,"topics":["github-api","nodejs","version-check","version-checker"],"latest_commit_sha":null,"homepage":"https://axelrindle.github.io/github-version-checker/","language":"TypeScript","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/axelrindle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-04-01T12:11:45.000Z","updated_at":"2024-07-15T16:14:11.000Z","dependencies_parsed_at":"2024-09-18T18:47:13.227Z","dependency_job_id":null,"html_url":"https://github.com/axelrindle/github-version-checker","commit_stats":{"total_commits":278,"total_committers":6,"mean_commits":"46.333333333333336","dds":0.2841726618705036,"last_synced_commit":"ec43806928534964c8d02dd41462ceefa7eb21f5"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelrindle%2Fgithub-version-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelrindle%2Fgithub-version-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelrindle%2Fgithub-version-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelrindle%2Fgithub-version-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/axelrindle","download_url":"https://codeload.github.com/axelrindle/github-version-checker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221842480,"owners_count":16890145,"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":["github-api","nodejs","version-check","version-checker"],"created_at":"2024-10-11T02:28:53.766Z","updated_at":"2024-10-28T14:45:20.493Z","avatar_url":"https://github.com/axelrindle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm legacy](https://img.shields.io/npm/v/github-version-checker?label=legacy\u0026logo=npm)](https://www.npmjs.com/package/github-version-checker)\n[![npm](https://img.shields.io/npm/v/@version-checker/core?logo=npm)](https://www.npmjs.com/package/@version-checker/core)\n![node-current (scoped)](https://img.shields.io/node/v/@version-checker/core?logo=node.js)\n\n[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/axelrindle/github-version-checker/ci.yml?branch=main\u0026logo=github)](https://github.com/axelrindle/github-version-checker/actions/workflows/ci.yml)\n[![GitHub Workflow Status (Docs)](https://img.shields.io/github/actions/workflow/status/axelrindle/github-version-checker/docs.yml?branch=main\u0026label=Docs\u0026logo=github)](https://github.com/axelrindle/github-version-checker/actions/workflows/docs.yml)\n[![Codacy grade](https://img.shields.io/codacy/grade/f82826738d2b43b1b8ba40dd780d1784?logo=codacy)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=axelrindle/github-version-checker\u0026amp;utm_campaign=Badge_Grade)\n[![Codacy coverage](https://img.shields.io/codacy/coverage/f82826738d2b43b1b8ba40dd780d1784?logo=codacy)](https://www.codacy.com/gh/axelrindle/github-version-checker/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=axelrindle/github-version-checker\u0026utm_campaign=Badge_Coverage)\n\n---\n\n🚧 **Notice** 🚧\n\n*This project is being renamed to just **version-checker** as I plan to support other platforms than Github in the future.*\n\n---\n\n# version-checker\n\n\u003e Simple **version checker** working with **GitHub releases** and the **GitHub API**.\n\n## Supported Node.js versions\n\n`\u003e= 14`\n\nWhile versions below 14.x are not officially tested they might work anyway.\n\nThe build works on 12.x so usage should be safe.\n\nEverything below 12.x is not guaranteed to work.\n\n## Is this ESM only?\n\n**No.**\n\nThis module may be require'd (CommonJS) or imported (ESM).\n\nI do not plan on making this an ESM only module in the near future.\n\n## Can I use this in the browser?\n\n**Yes**, starting with version **3.1.0**.\n\n[Go to the docs](https://axelrindle.github.io/github-version-checker/docs/next/browser-support/)\nfor instructions.\n\n## Install\n\n```bash\n$ npm install @version-checker/core\n```\n\n## Documentation\n\n[version-checker (axelrindle.github.io)](https://axelrindle.github.io/github-version-checker/)\n\n## Contributing\n\nFeel free to contribute to this project in any form.\nJust make sure to read the [Code of Conduct](https://github.com/axelrindle/github-version-checker/blob/main/CODE_OF_CONDUCT.md).\n\n[Open an issue](https://github.com/axelrindle/github-version-checker/issues/new) if there is anything you're having problems with.\n\n### Setup\n\nFirst of all clone the git repository :)\n\n```shell\n$ git clone https://github.com/axelrindle/github-version-checker.git\n```\n\nand then install the dependencies\n\n```shell\n$ npm ci\n```\n\nBy running [`npm ci`](https://docs.npmjs.com/cli/v9/commands/npm-ci) instead of [`npm i`](https://docs.npmjs.com/cli/v9/commands/npm-install) it is ensured that the dependency tree is installed exactly as stated in the [`package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json) file. That guarantees the usage of identical dependency trees throughout development.\n\n### Working on the packages\n\n1. Bootstrap the Lerna environment\n\n```shell\n$ npx lerna bootstrap\n```\n\n2. Do your changes on a seperate branch, e.g. `feature/my-bug-fix`\n\n3. When done, run tests using the following command:\n\n```shell\n$ npx lerna run test\n```\n\n### Contributing to the documentation\n\nAll documentation resided within the `docs/` directory. Is is built upon [Docusaurus](https://docusaurus.io/) and primarily written in Markdown.\n\nInstall dependencies using\n\n```shell\n$ npm ci\n```\n\nand start the development server by running\n\n```shell\n$ npm start\n```\n\nTo produce a production build, run\n\n```shell\n$ npm run build\n```\n\nThat produces a static site which can be served using\n\n```shell\n$ npm run serve\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelrindle%2Fgithub-version-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxelrindle%2Fgithub-version-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelrindle%2Fgithub-version-checker/lists"}