cranko 0.4.0

A cross-platform, cross-language release automation tool
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

// Copyright 2020 Peter Williams <peter@newton.cx> and collaborators
// Licensed under the MIT License.

//! Updating project versioning metadata in the repository.

use crate::{app::AppSession, errors::Result, repository::ChangeList};

/// A trait for something that can perform some kind of metadata rewriting.
pub trait Rewriter: std::fmt::Debug {
    /// Rewrite the metafiles to embed the project versions and internal
    /// dependency specifications captured in the current runtime state.
    fn rewrite(&self, app: &AppSession, changes: &mut ChangeList) -> Result<()>;

    /// Rewrite the metafiles to embed the Cranko-specific internal dependency
    /// version requirement metadata. This should not be done as part of the
    /// mainline rewriting process, but it is convenient to be able to do this
    /// on behalf of the user (e.g. generating `thiscommit:` strings and
    /// bootstrapping).
    fn rewrite_cranko_requirements(
        &self,
        _app: &AppSession,
        _changes: &mut ChangeList,
    ) -> Result<()> {
        Ok(())
    }
}