{"id":28353113,"url":"https://github.com/gmtprime/version_check","last_synced_at":"2025-08-28T12:18:53.504Z","repository":{"id":62430698,"uuid":"72458710","full_name":"gmtprime/version_check","owner":"gmtprime","description":"Alerts of new application versions in Hex","archived":false,"fork":false,"pushed_at":"2016-11-01T12:04:56.000Z","size":10,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-14T02:56:47.123Z","etag":null,"topics":["elixir","utility","versioncheck"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gmtprime.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-31T17:04:37.000Z","updated_at":"2017-09-08T21:25:22.000Z","dependencies_parsed_at":"2022-11-01T20:19:52.371Z","dependency_job_id":null,"html_url":"https://github.com/gmtprime/version_check","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/gmtprime/version_check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmtprime%2Fversion_check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmtprime%2Fversion_check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmtprime%2Fversion_check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmtprime%2Fversion_check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gmtprime","download_url":"https://codeload.github.com/gmtprime/version_check/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmtprime%2Fversion_check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272498196,"owners_count":24944819,"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","status":"online","status_checked_at":"2025-08-28T02:00:10.768Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["elixir","utility","versioncheck"],"created_at":"2025-05-28T00:10:44.563Z","updated_at":"2025-08-28T12:18:53.449Z","avatar_url":"https://github.com/gmtprime.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VersionCheck\n\n[![Build Status](https://travis-ci.org/gmtprime/version_check.svg?branch=master)](https://travis-ci.org/gmtprime/version_check) [![Hex pm](http://img.shields.io/hexpm/v/version_check.svg?style=flat)](https://hex.pm/packages/version_check) [![hex.pm downloads](https://img.shields.io/hexpm/dt/version_check.svg?style=flat)](https://hex.pm/packages/version_check) [![Deps Status](https://beta.hexfaktor.org/badge/all/github/gmtprime/version_check.svg)](https://beta.hexfaktor.org/github/gmtprime/version_check) [![Inline docs](http://inch-ci.org/github/gmtprime/version_check.svg?branch=master)](http://inch-ci.org/github/gmtprime/version_check)\n\nThis module defines an application and a macro to generate alerts about new\nversions of applications in Hex. The messages are shown using `Logger` as a\nwarning.\n\nWhen starting an app using the function or the `VersionCheck` application you\nshould see something like:\n\n```elixir\n% iex -S mix\nErlang/OTP 19 [erts-8.1] [source-4cc2ce3] [64-bit] [smp:8:8] [async-threads:10]\n[hipe] [kernel-poll:false]\n\nInteractive Elixir (1.3.2) - press Ctrl+C to exit (type h() ENTER for help)\n\n17:30:42.454 [warn] A new yggdrasil version is available (2.0.8 \u003e 2.0.7)\n17:30:42.454 [debug] Using the latest version of :version_check (0.1.0)\niex(1)\u003e\n```\n\n## Using VersionCheck\n\nWhen adding `use VersionCheck` to a module, the module adds the public\nfunction `check_version/0`. If it is called from inside the `start/2`\nfunction of the `Application` behaviour it'll check the current application\nversion against `hex.pm` before it starts i.e:\n\n```elixir\ndefmodule MyApp do\n  use Application\n  use VersionCheck, application: :my_app\n\n  def start(_type, _args) do\n    import Supervisor.Spec, warn: false\n\n    check_version()\n\n    children = [\n      (...)\n    ]\n        \n    opts = (...)\n\n    Supervisor.start_link(children, opts)\n  end\nend\n```\n\n## VersionCheck App\n\nIt is also possible to add `VersionCheck` to your required applications in\nyour `mix.exs` file i.e:\n\n```elixir\ndef application do\n  [applications: [:version_check]]\nend\n```\n\nThis app will check the version of every application started. That's why it\nshould be the last application in the list.\n\n\n## Installation\n\nJust add it to your deps:\n\n```elixir\ndef deps do\n  [{:version_check, \"~\u003e 0.1\"}]\nend\n```\n\nTo use it as an application, ensure it is started before your application and\nafter all the applications required by your application:\n\n```elixir\ndef application do\n  [applications: [(...), :version_check]]\nend\n```\n\n## Credits\n\n`VersionCheck` owns its existence to the study and \"code borrowing\" from\n`Credo`'s function that checks for updates.\n\n## Author\n\nAlexander de Sousa.\n\n## License\n\n`Yggdrasil` is released under the MIT License. See the LICENSE file for further\ndetails.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmtprime%2Fversion_check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgmtprime%2Fversion_check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmtprime%2Fversion_check/lists"}