get_github_release
This will verify if a given release version is available on GitHub
This will return all information about a release. For example:
{ "url"=>"https://api.github.com/repos/KrauseFx/pantograph/releases/1537713", "assets_url"=>"https://api.github.com/repos/KrauseFx/pantograph/releases/1537713/assets", "upload_url"=>"https://uploads.github.com/repos/KrauseFx/pantograph/releases/1537713/assets{?name}", "html_url"=>"https://github.com/urbanquakers/pantograph/releases/tag/1.8.0", "id"=>1537713, "tag_name"=>"1.8.0", "target_commitish"=>"master", "name"=>"1.8.0 Switch Lanes & Pass Parameters", "draft"=>false, "author"=> {"login"=>"KrauseFx", "id"=>869950, "avatar_url"=>"https://avatars.githubusercontent.com/u/869950?v=3", "gravatar_id"=>"", "url"=>"https://api.github.com/users/KrauseFx", "html_url"=>"https://github.com/pantograph", "followers_url"=>"https://api.github.com/users/KrauseFx/followers", "following_url"=>"https://api.github.com/users/KrauseFx/following{/other_user}", "gists_url"=>"https://api.github.com/users/KrauseFx/gists{/gist_id}", "starred_url"=>"https://api.github.com/users/KrauseFx/starred{/owner}{/repo}", "subscriptions_url"=>"https://api.github.com/users/KrauseFx/subscriptions", "organizations_url"=>"https://api.github.com/users/KrauseFx/orgs", "repos_url"=>"https://api.github.com/users/KrauseFx/repos", "events_url"=>"https://api.github.com/users/KrauseFx/events{/privacy}", "received_events_url"=>"https://api.github.com/users/KrauseFx/received_events", "type"=>"User", "site_admin"=>false}, "prerelease"=>false, "created_at"=>"2015-07-14T23:33:01Z", "published_at"=>"2015-07-14T23:44:10Z", "assets"=>[], "tarball_url"=>"https://api.github.com/repos/KrauseFx/pantograph/tarball/1.8.0", "zipball_url"=>"https://api.github.com/repos/KrauseFx/pantograph/zipball/1.8.0", "body"=> ...Markdown... "This is one of the biggest updates of _pantograph_ yet" }
| get_github_release | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @KrauseFx, @czechboy0, @jaleksynas, @tommeier |
1 Example
release = get_github_release(url: "urbanquakers/pantograph", version: "1.0.0") puts release["name"]
Parameters
| Key | Description | Default |
|---|---|---|
url |
The path to your repo, e.g. 'urbanquakers/pantograph' | |
server_url |
The server url. e.g. 'https://your.github.server/api/v3' (Default: 'https://api.github.com') | https://api.github.com |
version |
The version tag of the release to check | |
api_token |
GitHub Personal Token (required for private repositories) |
* = default value is dependent on the user's system
Lane Variables
Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The get_github_release action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::GET_GITHUB_RELEASE_INFO |
Contains all the information about this release |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
pantograph action get_github_release
CLI
It is recommended to add the above action into your Pantfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run get_github_release
To pass parameters, make use of the : symbol, for example
pantograph run get_github_release parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all pantograph actions you use to your Pantfile.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub