Struct revelio::Context

pub struct Context {
    pub build_url: String,
    pub sources_url: String,
    pub commit_sha1: String,
    pub commit_url: String,
    pub compare_url: String,
}

Contains public information about discoverability of a build and its sources

All URLs stored in these fields should be publicly accessible on the web (ie: not behind a paywall or requiring subscription to a free service).

Fields

build_url: String

URL of the build job on the CI platform

Example: https://travis-ci.com/47ng/revelio

sources_url: String

URL of the sources in the public repository

Example: https://github.com/47ng/revelio

commit_sha1: String

SHA-1 hash of the commit at the HEAD of that build

Example: 3f5dd7c301184862f5da07cde403bfdc7609e61a

commit_url: String

Public URL to the commit at the HEAD of that build

Example: https://github.com/47ng/revelio/commit/3f5dd7c301184862f5da07cde403bfdc7609e61a

compare_url: String

Public URL to a list of commits that were included in that build

Example: https://github.com/47ng/revelio/compare/c8eee0fa854a...3f5dd7c30118

Methods

impl Context

pub fn from_env() -> Option<Self>

Try to generate a Context by sniffing the environment

This will call the available CI sniffers in turn.

Trait Implementations

impl Debug for Context

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for Context

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Context

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.