flowey_lib_hvlite/_jobs/
consolidate_and_publish_gh_pages.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! Consolidate various pre-built HTML artifacts (guide, docs, etc...), and glue
5//! them together into a single HTML bundle which can be published to
6//! `openvmm.dev` via gh pages.
7
8use crate::build_guide::GuideOutput;
9use crate::build_rustdoc::RustdocOutput;
10use flowey::node::prelude::*;
11
12flowey_request! {
13    pub struct Params {
14        pub rustdoc_linux: ReadVar<RustdocOutput>,
15        pub rustdoc_windows: ReadVar<RustdocOutput>,
16        pub guide: ReadVar<GuideOutput>,
17        pub output: WriteVar<GhPagesOutput>,
18    }
19}
20
21#[derive(Serialize, Deserialize)]
22pub struct GhPagesOutput {
23    pub gh_pages: PathBuf,
24}
25
26impl Artifact for GhPagesOutput {}
27
28new_simple_flow_node!(struct Node);
29
30impl SimpleFlowNode for Node {
31    type Request = Params;
32
33    fn imports(ctx: &mut ImportCtx<'_>) {
34        ctx.import::<crate::git_checkout_openvmm_repo::Node>();
35        ctx.import::<crate::_jobs::build_test_results_website::Node>();
36    }
37
38    fn process_request(request: Self::Request, ctx: &mut NodeCtx<'_>) -> anyhow::Result<()> {
39        let Params {
40            rustdoc_linux,
41            rustdoc_windows,
42            guide: rendered_guide,
43            output,
44        } = request;
45
46        let logview_build =
47            ctx.reqv(|v| crate::_jobs::build_test_results_website::Request { path: v });
48
49        let consolidated_html = ctx.emit_rust_stepv("generate consolidated gh pages html", |ctx| {
50            let rendered_guide = rendered_guide.claim(ctx);
51            let rustdoc_windows = rustdoc_windows.claim(ctx);
52            let rustdoc_linux = rustdoc_linux.claim(ctx);
53            let logview_build = logview_build.claim(ctx);
54            |rt| {
55                let rendered_guide = rt.read(rendered_guide);
56                let rustdoc_windows = rt.read(rustdoc_windows);
57                let rustdoc_linux = rt.read(rustdoc_linux);
58                let logview_build = rt.read(logview_build);
59
60                let consolidated_html = std::env::current_dir()?.join("out").absolute()?;
61                fs_err::create_dir(&consolidated_html)?;
62
63                // DEVNOTE: Please try to keep this top-level structure stable!
64                //
65                // As the project grows, its quite likely more external websites
66                // will be linking to specific pages under `openvmm.dev`. Lets
67                // do our best to avoid linkrot, and if we are moving things
68                // around, lets make sure to add appropriate redirects whenever
69                // we can.
70
71                // Make the OpenVMM Guide accessible under `openvmm.dev/guide/`
72                flowey_lib_common::_util::copy_dir_all(
73                    rendered_guide.guide,
74                    consolidated_html.join("guide"),
75                )?;
76
77                // Make rustdocs accessible under `openvmm.dev/rustdoc/{platform}`
78                flowey_lib_common::_util::copy_dir_all(
79                    rustdoc_windows.docs,
80                    consolidated_html.join("rustdoc/windows"),
81                )?;
82                flowey_lib_common::_util::copy_dir_all(
83                    rustdoc_linux.docs,
84                    consolidated_html.join("rustdoc/linux"),
85                )?;
86
87                // New logviewer (built in CI).
88                flowey_lib_common::_util::copy_dir_all(
89                    logview_build,
90                    consolidated_html.join("test-results"),
91                )?;
92
93                // as we do not currently have any form of "landing page",
94                // redirect `openvmm.dev` to `openvmm.dev/guide`
95                fs_err::write(consolidated_html.join("index.html"), REDIRECT)?;
96
97                Ok(consolidated_html)
98            }
99        });
100
101        let consolidated_html = if matches!(ctx.backend(), FlowBackend::Github) {
102            let did_upload = ctx
103                .emit_gh_step("Upload pages artifact", "actions/upload-pages-artifact@v4")
104                .with(
105                    "path",
106                    consolidated_html.map(ctx, |x| x.display().to_string()),
107                )
108                .finish(ctx);
109
110            let did_deploy = ctx
111                .emit_gh_step("Deploy to GitHub Pages", "actions/deploy-pages@v4")
112                .requires_permission(GhPermission::IdToken, GhPermissionValue::Write)
113                .requires_permission(GhPermission::Pages, GhPermissionValue::Write)
114                .run_after(did_upload)
115                .finish(ctx);
116
117            consolidated_html.depending_on(ctx, &did_deploy)
118        } else {
119            consolidated_html
120        };
121
122        consolidated_html.write_into(ctx, output, |p| GhPagesOutput { gh_pages: p });
123        Ok(())
124    }
125}
126
127const REDIRECT: &str = r#"
128<!DOCTYPE html>
129<html>
130<head>
131    <title>Redirecting...</title>
132    <link rel="canonical" href="/guide"/>
133    <meta charset="utf-8"/>
134    <meta http-equiv="refresh" content="0; url=/guide">
135</head>
136<body>
137    <p>If you are not redirected automatically, follow this <a href="/guide">link to openvmm.dev/guide</a>.</p>
138</body>
139</html>
140"#;
flowey_lib_hvlite/_jobs/consolidate_and_publish_gh_pages.rs

flowey_lib_hvlite/_jobs/
consolidate_and_publish_gh_pages.rs
