monochange_github 0.1.0

GitHub release payload rendering and publishing for monochange
Documentation 
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# `monochange_github`

<br />

<!-- {=crateReadmeBadgeRow} -->

[![Crates.io][crate-image]][crate-link] [![Docs.rs][docs-image]][docs-link] [![CI][ci-status-image]][ci-status-link] [![Coverage][coverage-image]][coverage-link] [![License][license-image]][license-link]

<!-- {/crateReadmeBadgeRow} -->

<br />

<!-- {=monochangeGithubCrateDocs} -->

`monochange_github` turns `monochange` release manifests into GitHub automation requests.

Reach for this crate when you want to preview or publish GitHub releases and release pull requests using the same structured release data that powers changelog files and release manifests.

## Why use it?

- derive GitHub release payloads and release-PR bodies from `monochange`'s structured release manifest
- keep GitHub automation aligned with changelog rendering and release targets
- reuse one publishing path for dry-run previews and real repository updates

## Best for

- building GitHub release automation on top of `mc release`
- previewing would-be GitHub releases and release PRs in CI before publishing
- converting grouped or package release targets into repository automation payloads

## Public entry points

- `build_release_requests(config, manifest)` converts a release manifest into GitHub release requests
- `publish_release_requests(requests)` publishes requests through the GitHub API via `octocrab`
- `build_release_pull_request_request(config, manifest)` converts a release manifest into a GitHub release-PR request
- `publish_release_pull_request(root, request, tracked_paths)` creates or updates a release PR through `git` and the GitHub API

## Example

```rust
use monochange_core::ProviderBotSettings;
use monochange_core::ProviderMergeRequestSettings;
use monochange_core::ProviderReleaseSettings;
use monochange_core::SourceConfiguration;
use monochange_core::SourceProvider;
use monochange_core::ReleaseManifest;
use monochange_core::ReleaseManifestPlan;
use monochange_core::ReleaseManifestTarget;
use monochange_core::ReleaseOwnerKind;
use monochange_core::VersionFormat;
use monochange_github::build_release_requests;

let manifest = ReleaseManifest {
    command: "release".to_string(),
    dry_run: true,
    version: Some("1.2.0".to_string()),
    group_version: Some("1.2.0".to_string()),
    release_targets: vec![ReleaseManifestTarget {
        id: "sdk".to_string(),
        kind: ReleaseOwnerKind::Group,
        version: "1.2.0".to_string(),
        tag: true,
        release: true,
        version_format: VersionFormat::Primary,
        tag_name: "v1.2.0".to_string(),
        members: vec!["core".to_string(), "app".to_string()],
        rendered_title: "1.2.0 (2026-04-06)".to_string(),
        rendered_changelog_title: "[1.2.0](https://example.com) (2026-04-06)".to_string(),
    }],
    released_packages: vec!["workflow-core".to_string(), "workflow-app".to_string()],
    changed_files: Vec::new(),
    changesets: Vec::new(),
    changelogs: Vec::new(),
    deleted_changesets: Vec::new(),
    plan: ReleaseManifestPlan {
        workspace_root: std::path::PathBuf::from("."),
        decisions: Vec::new(),
        groups: Vec::new(),
        warnings: Vec::new(),
        unresolved_items: Vec::new(),
        compatibility_evidence: Vec::new(),
    },
};
let github = SourceConfiguration {
    provider: SourceProvider::GitHub,
    owner: "ifiokjr".to_string(),
    repo: "monochange".to_string(),
    host: None,
    api_url: None,
    releases: ProviderReleaseSettings::default(),
    pull_requests: ProviderMergeRequestSettings::default(),
    bot: ProviderBotSettings::default(),
};

let requests = build_release_requests(&github, &manifest);

assert_eq!(requests.len(), 1);
assert_eq!(requests[0].tag_name, "v1.2.0");
assert_eq!(requests[0].repository, "ifiokjr/monochange");
```

<!-- {/monochangeGithubCrateDocs} -->

<!-- {=monochangeGithubBadgeLinks} -->

[crate-image]: https://img.shields.io/badge/crates.io-monochange__github-orange?logo=rust
[crate-link]: https://crates.io/crates/monochange_github
[docs-image]: https://img.shields.io/badge/docs.rs-monochange__github-1f425f?logo=docs.rs
[docs-link]: https://docs.rs/monochange_github/

<!-- {/monochangeGithubBadgeLinks} -->

<!-- {=repoStatusBadgeLinks} -->

[ci-status-image]: https://github.com/ifiokjr/monochange/actions/workflows/ci.yml/badge.svg
[ci-status-link]: https://github.com/ifiokjr/monochange/actions/workflows/ci.yml
[coverage-image]: https://codecov.io/gh/ifiokjr/monochange/branch/main/graph/badge.svg
[coverage-link]: https://codecov.io/gh/ifiokjr/monochange
[license-image]: https://img.shields.io/badge/license-Unlicense-blue.svg
[license-link]: https://opensource.org/license/unlicense

<!-- {/repoStatusBadgeLinks} -->