github_workflows_update/
lib.rs

1// Copyright (C) 2022 Leandro Lisboa Penz <lpenz@lpenz.org>
2// This file is subject to the terms and conditions defined in
3// file 'LICENSE', which is part of this source code package.
4
5//! Check if github actions used in a workflow can be updated
6//!
7//! # Code structure
8//!
9//! - Utility modules:
10//!   - [`cmd`]: command line arguments parsing and main function.
11//!   - [`error`]: `Error` and `Result` types.
12//!   - [`version`]: type wrapper for versions; currently using.
13//!     [`semver`] with [`lenient_semver`]
14//! - Main functionality:
15//!   - [`processor`]: top level file processing function.
16//!   - [`workflow`]: workflow file parsing, into [`workflow::Workflow`] type.
17//!     The workflow has the the set of resource-versions that the workflow
18//!     `uses`, and also fetches all latest versions using the proxy.
19//!   - [`proxy`]: a proxy [`proxy::Server`] that makes async
20//!     requests and caches the results.
21
22pub mod cmd;
23pub mod error;
24pub mod processor;
25pub mod proxy;
26pub mod resource;
27pub mod updater;
28pub mod version;
29pub mod workflow;