Skip to main content

GithubActionsRegistry

Struct GithubActionsRegistry 

pub struct GithubActionsRegistry { /* private fields */ }
Expand description

Client for fetching GitHub Actions version information from the GitHub tags API.

Implementations§

§

impl GithubActionsRegistry

pub fn new(cache: Arc<HttpCache>) -> GithubActionsRegistry

Creates a new GitHub Actions registry client with the given HTTP cache.

Reads GITHUB_TOKEN from the environment for authenticated requests (5000 req/h vs 60 req/h unauthenticated) — identical to deps_swift::registry::SwiftRegistry, and note the 60 req/h unauthenticated budget is per-IP and shared with any deps-swift traffic in the same process.

pub fn tag_index(&self) -> Arc<DashMap<PackageName, Arc<TagIndex>>>

Shares this registry’s [TagIndex] map with a crate::formatter::GithubActionsFormatter, so a formatted SHA-pin edit can resolve the new SHA for a given tag.

pub, not pub(crate): an integration test that exercises the shared deps_core code-action/code-lens/hover machinery against this ecosystem — which never itself drives a live registry fetch — needs a way to seed a repository’s [TagIndex] entry directly, without going through a mocked HTTP fetch that path never calls.

pub async fn get_versions( &self, name: &str, ) -> Result<Vec<GithubActionsVersion>, DepsError>

Fetches all semver-tagged versions for name (owner/repo).

Returns versions sorted newest-first. Non-semver tags are skipped. Follows GitHub tags pagination up to MAX_TAG_PAGES pages, coalesced per-repository so that N concurrent callers for the same repository on a cold cache issue one request, not N (S2) — and short-circuits locally, without touching the network, once the rate-limit gate has been tripped by an earlier 403 (critic C1).

pub async fn get_versions_with_release_dates( &self, name: &str, ) -> Result<Vec<GithubActionsVersion>, DepsError>

Like GithubActionsRegistry::get_versions, but also attaches GitHub Release publish times, joined by normalized tag name (#486, mirroring deps_swift::registry::SwiftRegistry::get_versions_with_release_dates).

Runs the tags fetch and the release-dates fetch concurrently (tokio::join!) — the release-dates fetch is infallible (empty map on any failure), so it can never perturb get_versions’s error propagation, rate-limit gate, or in-flight coalescing.

Known limitation (#486 critic M2): the release-dates fetch does not consult the rate-limit gate. This is harmless in the untokened case (ReleaseDatesCache:: fetch already short-circuits on a missing GITHUB_TOKEN before issuing any request), but a tokened client exhausting its 5000/h quota keeps retrying /releases every error TTL (90s) per repository rather than backing off — gating this call on RateLimitGate::is_tripped would not help: map_tags_error deliberately never trips the gate for a tokened 403 (that case is scoped to one repository, not treated as a workspace-wide outage), so the gate never becomes tripped while a token is present. Left unfixed rather than adding a check that would never fire in the tokened case it targets.

pub async fn get_latest_matching( &self, name: &str, req_str: &str, ) -> Result<Option<GithubActionsVersion>, DepsError>

Finds the latest version satisfying the given semver requirement.

Trait Implementations§

§

impl Clone for GithubActionsRegistry

§

fn clone(&self) -> GithubActionsRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Registry for GithubActionsRegistry

§

fn search<'a>( &'a self, _query: &'a str, _limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Metadata>>, DepsError>> + Send + 'a>>

Always empty for the MVP (S2/registry docs): a name-completion search would burn the 60 req/h unauthenticated budget per keystroke, since GitHub has no action-specific search endpoint cheaper than repository search.

§

fn reports_yanked(&self) -> bool

GitHub’s tags API exposes no yank/deprecation signal for actions.

§

fn get_versions<'a>( &'a self, name: &'a PackageName, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>

Fetches all available versions for a package. Read more
§

fn get_versions_with<'a>( &'a self, name: &'a PackageName, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>

Like get_versions, but lets a registry that can obtain Version::published_at only through an extra request gate that request behind freshness.enabled instead of always paying for it. Read more
§

fn get_latest_matching<'a>( &'a self, name: &'a PackageName, req: &'a VersionReq, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>

Finds the latest version matching a version requirement. Read more
§

fn select_latest_matching( &self, versions: &[Box<dyn Version>], req: &VersionReq, ) -> Option<usize>

Index of the latest version in versions satisfying req, with no I/O. Read more
§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to concrete registry type for ecosystem-specific operations
Source§

fn get_versions_from<'a>( &'a self, name: &'a PackageName, source: &'a DependencySource, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>

Like get_versions_with, but additionally carries the dependency’s resolved DependencySource, for a registry that routes a single fetch across more than one underlying index (e.g. deps-cargo’s CargoRegistry, which dispatches a DependencySource::AlternateRegistry to a private sparse index instead of crates.io). Read more
Source§

fn get_latest_matching_with_context<'a>( &'a self, name: &'a PackageName, req: &'a VersionReq, minimum_stability: Option<&'a str>, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>

Like get_latest_matching, but lets a registry whose “latest matching” selection can be refined by ecosystem-specific manifest state (e.g. Composer’s minimum-stability field, #424) read it, alongside req. Read more
Source§

fn get_latest_matching_from<'a>( &'a self, name: &'a PackageName, source: &'a DependencySource, req: &'a VersionReq, minimum_stability: Option<&'a str>, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>

Like get_latest_matching_with_context, but additionally carries the dependency’s resolved DependencySource — the get_latest_matching-shaped counterpart to get_versions_from, covering the fallback path a caller takes when the list-based pick fails on a non-empty get_versions_from result (see deps_core::lsp_helpers::hover’s list_fallback_latest and deps-lsp’s background-fetch fallback for the two call sites this exists for). Read more
Source§

fn select_latest_matching_with_context( &self, versions: &[Box<dyn Version>], req: &VersionReq, minimum_stability: Option<&str>, ) -> Option<usize>

Like select_latest_matching, but lets a registry whose selection can be refined by ecosystem-specific manifest state (e.g. Composer’s minimum-stability field, #424) read it, alongside versions and req. See get_latest_matching_with_context for why minimum_stability is an opaque per-ecosystem string rather than a shared type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more