https://github.com/genieframework/versioncheck.jl
Utility package that helps with checking and notifying users of package updates
https://github.com/genieframework/versioncheck.jl
Last synced: 4 months ago
JSON representation
Utility package that helps with checking and notifying users of package updates
- Host: GitHub
- URL: https://github.com/genieframework/versioncheck.jl
- Owner: GenieFramework
- License: mit
- Created: 2021-11-07T14:00:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-18T14:11:30.000Z (over 4 years ago)
- Last Synced: 2025-01-14T07:12:27.949Z (over 1 year ago)
- Language: Julia
- Size: 11.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG_sample.html
- License: LICENSE
Awesome Lists containing this project
README
# VersionCheck
Utility package for checking if a new version of a Julia package is available. It uses the current `Project.toml` file and a special `CHANGELOG.html` file to determine the latest versions.
## Usage
Create a `CHANGELOG.html` file similar to the `CHANGELOG_sample.html` file included in this package. Host the `CHANGELOG.html` file on a publicly accessible web server.
In your package, add a check like the following:
```julia
module MyPackage
import VersionCheck
function __init__()
try
@async VersionCheck.newversion("MyPackage", url = "")
catch
end
end
end
```
### TODO
* API to export CHANGELOG.html to CHANGELOG.md