| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `xtask/src/publish.rs`."><title>publish.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="xtask" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">xtask/</div>publish.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>notes; |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span><span class="kw">crate</span>::flags; |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>anyhow::bail; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::env; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>xshell::{Shell, cmd}; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">impl </span>flags::PublishReleaseNotes { |
| <a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>run(<span class="self">self</span>, sh: <span class="kw-2">&</span>Shell) -> anyhow::Result<()> { |
| <a href=#10 id=10 data-nosnippet>10</a> <span class="kw">let </span>asciidoc = sh.read_file(<span class="kw-2">&</span><span class="self">self</span>.changelog)<span class="question-mark">?</span>; |
| <a href=#11 id=11 data-nosnippet>11</a> <span class="kw">let </span><span class="kw-2">mut </span>markdown = notes::convert_asciidoc_to_markdown(std::io::Cursor::new(<span class="kw-2">&</span>asciidoc))<span class="question-mark">?</span>; |
| <a href=#12 id=12 data-nosnippet>12</a> <span class="kw">if </span>!markdown.starts_with(<span class="string">"# Changelog"</span>) { |
| <a href=#13 id=13 data-nosnippet>13</a> <span class="macro">bail!</span>(<span class="string">"changelog Markdown should start with `# Changelog`"</span>); |
| <a href=#14 id=14 data-nosnippet>14</a> } |
| <a href=#15 id=15 data-nosnippet>15</a> <span class="kw">const </span>NEWLINES: <span class="kw-2">&</span>str = <span class="string">"\n\n"</span>; |
| <a href=#16 id=16 data-nosnippet>16</a> <span class="kw">let </span><span class="prelude-val">Some</span>(idx) = markdown.find(NEWLINES) <span class="kw">else </span>{ |
| <a href=#17 id=17 data-nosnippet>17</a> <span class="macro">bail!</span>(<span class="string">"missing newlines after changelog title"</span>); |
| <a href=#18 id=18 data-nosnippet>18</a> }; |
| <a href=#19 id=19 data-nosnippet>19</a> markdown.replace_range(<span class="number">0</span>..idx + NEWLINES.len(), <span class="string">""</span>); |
| <a href=#20 id=20 data-nosnippet>20</a> |
| <a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>file_name = check_file_name(<span class="self">self</span>.changelog)<span class="question-mark">?</span>; |
| <a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>tag_name = <span class="kw-2">&</span>file_name[<span class="number">0</span>..<span class="number">10</span>]; |
| <a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>original_changelog_url = create_original_changelog_url(<span class="kw-2">&</span>file_name); |
| <a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span>additional_paragraph = |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="macro">format!</span>(<span class="string">"\nSee also the [changelog post]({original_changelog_url})."</span>); |
| <a href=#26 id=26 data-nosnippet>26</a> markdown.push_str(<span class="kw-2">&</span>additional_paragraph); |
| <a href=#27 id=27 data-nosnippet>27</a> <span class="kw">if </span><span class="self">self</span>.dry_run { |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="macro">println!</span>(<span class="string">"{markdown}"</span>); |
| <a href=#29 id=29 data-nosnippet>29</a> } <span class="kw">else </span>{ |
| <a href=#30 id=30 data-nosnippet>30</a> update_release(sh, tag_name, <span class="kw-2">&</span>markdown)<span class="question-mark">?</span>; |
| <a href=#31 id=31 data-nosnippet>31</a> } |
| <a href=#32 id=32 data-nosnippet>32</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#33 id=33 data-nosnippet>33</a> } |
| <a href=#34 id=34 data-nosnippet>34</a>} |
| <a href=#35 id=35 data-nosnippet>35</a> |
| <a href=#36 id=36 data-nosnippet>36</a><span class="kw">fn </span>check_file_name<P: AsRef<std::path::Path>>(path: P) -> anyhow::Result<String> { |
| <a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span>file_name = path |
| <a href=#38 id=38 data-nosnippet>38</a> .as_ref() |
| <a href=#39 id=39 data-nosnippet>39</a> .file_name() |
| <a href=#40 id=40 data-nosnippet>40</a> .ok_or_else(|| <span class="macro">anyhow::format_err!</span>(<span class="string">"file name is not specified as `changelog`"</span>))<span class="question-mark">? |
| <a href=#41 id=41 data-nosnippet>41</a> </span>.to_string_lossy(); |
| <a href=#42 id=42 data-nosnippet>42</a> |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span><span class="kw-2">mut </span>chars = file_name.chars(); |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">if </span>file_name.len() >= <span class="number">10 |
| <a href=#45 id=45 data-nosnippet>45</a> </span>&& chars.next().unwrap().is_ascii_digit() |
| <a href=#46 id=46 data-nosnippet>46</a> && chars.next().unwrap().is_ascii_digit() |
| <a href=#47 id=47 data-nosnippet>47</a> && chars.next().unwrap().is_ascii_digit() |
| <a href=#48 id=48 data-nosnippet>48</a> && chars.next().unwrap().is_ascii_digit() |
| <a href=#49 id=49 data-nosnippet>49</a> && chars.next().unwrap() == <span class="string">'-' |
| <a href=#50 id=50 data-nosnippet>50</a> </span>&& chars.next().unwrap().is_ascii_digit() |
| <a href=#51 id=51 data-nosnippet>51</a> && chars.next().unwrap().is_ascii_digit() |
| <a href=#52 id=52 data-nosnippet>52</a> && chars.next().unwrap() == <span class="string">'-' |
| <a href=#53 id=53 data-nosnippet>53</a> </span>&& chars.next().unwrap().is_ascii_digit() |
| <a href=#54 id=54 data-nosnippet>54</a> && chars.next().unwrap().is_ascii_digit() |
| <a href=#55 id=55 data-nosnippet>55</a> { |
| <a href=#56 id=56 data-nosnippet>56</a> <span class="prelude-val">Ok</span>(file_name.to_string()) |
| <a href=#57 id=57 data-nosnippet>57</a> } <span class="kw">else </span>{ |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="macro">bail!</span>(<span class="string">"unexpected file name format; no date information prefixed"</span>) |
| <a href=#59 id=59 data-nosnippet>59</a> } |
| <a href=#60 id=60 data-nosnippet>60</a>} |
| <a href=#61 id=61 data-nosnippet>61</a> |
| <a href=#62 id=62 data-nosnippet>62</a><span class="kw">fn </span>create_original_changelog_url(file_name: <span class="kw-2">&</span>str) -> String { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>year = <span class="kw-2">&</span>file_name[<span class="number">0</span>..<span class="number">4</span>]; |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>month = <span class="kw-2">&</span>file_name[<span class="number">5</span>..<span class="number">7</span>]; |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>day = <span class="kw-2">&</span>file_name[<span class="number">8</span>..<span class="number">10</span>]; |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="kw">let </span><span class="kw-2">mut </span>stem = <span class="kw-2">&</span>file_name[<span class="number">11</span>..]; |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(stripped) = stem.strip_suffix(<span class="string">".adoc"</span>) { |
| <a href=#68 id=68 data-nosnippet>68</a> stem = stripped; |
| <a href=#69 id=69 data-nosnippet>69</a> } |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="macro">format!</span>(<span class="string">"https://rust-analyzer.github.io/thisweek/{year}/{month}/{day}/{stem}.html"</span>) |
| <a href=#71 id=71 data-nosnippet>71</a>} |
| <a href=#72 id=72 data-nosnippet>72</a> |
| <a href=#73 id=73 data-nosnippet>73</a><span class="kw">fn </span>update_release(sh: <span class="kw-2">&</span>Shell, tag_name: <span class="kw-2">&</span>str, release_notes: <span class="kw-2">&</span>str) -> anyhow::Result<()> { |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>token = <span class="kw">match </span>env::var(<span class="string">"GITHUB_TOKEN"</span>) { |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="prelude-val">Ok</span>(token) => token, |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">bail!</span>( |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="string">"Please obtain a personal access token from https://github.com/settings/tokens and set the `GITHUB_TOKEN` environment variable." |
| <a href=#78 id=78 data-nosnippet>78</a> </span>), |
| <a href=#79 id=79 data-nosnippet>79</a> }; |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>accept = <span class="string">"Accept: application/vnd.github+json"</span>; |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="kw">let </span>authorization = <span class="macro">format!</span>(<span class="string">"Authorization: Bearer {token}"</span>); |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>api_version = <span class="string">"X-GitHub-Api-Version: 2022-11-28"</span>; |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>release_url = <span class="string">"https://api.github.com/repos/rust-lang/rust-analyzer/releases"</span>; |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span>release_json = <span class="macro">cmd!</span>( |
| <a href=#86 id=86 data-nosnippet>86</a> sh, |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="string">"curl -sf -H {accept} -H {authorization} -H {api_version} {release_url}/tags/{tag_name}" |
| <a href=#88 id=88 data-nosnippet>88</a> </span>) |
| <a href=#89 id=89 data-nosnippet>89</a> .read()<span class="question-mark">?</span>; |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="kw">let </span>release_id = <span class="macro">cmd!</span>(sh, <span class="string">"jq .id"</span>).stdin(release_json).read()<span class="question-mark">?</span>; |
| <a href=#91 id=91 data-nosnippet>91</a> |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="kw">let </span><span class="kw-2">mut </span>patch = String::new(); |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="comment">// note: the GitHub API doesn't update the target commit if the tag already exists |
| <a href=#94 id=94 data-nosnippet>94</a> </span>write_json::object(<span class="kw-2">&mut </span>patch) |
| <a href=#95 id=95 data-nosnippet>95</a> .string(<span class="string">"tag_name"</span>, tag_name) |
| <a href=#96 id=96 data-nosnippet>96</a> .string(<span class="string">"target_commitish"</span>, <span class="string">"master"</span>) |
| <a href=#97 id=97 data-nosnippet>97</a> .string(<span class="string">"name"</span>, tag_name) |
| <a href=#98 id=98 data-nosnippet>98</a> .string(<span class="string">"body"</span>, release_notes) |
| <a href=#99 id=99 data-nosnippet>99</a> .bool(<span class="string">"draft"</span>, <span class="bool-val">false</span>) |
| <a href=#100 id=100 data-nosnippet>100</a> .bool(<span class="string">"prerelease"</span>, <span class="bool-val">false</span>); |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="kw">let _ </span>= <span class="macro">cmd!</span>( |
| <a href=#102 id=102 data-nosnippet>102</a> sh, |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="string">"curl -sf -X PATCH -H {accept} -H {authorization} -H {api_version} {release_url}/{release_id} -d {patch}" |
| <a href=#104 id=104 data-nosnippet>104</a> </span>) |
| <a href=#105 id=105 data-nosnippet>105</a> .read()<span class="question-mark">?</span>; |
| <a href=#106 id=106 data-nosnippet>106</a> |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#108 id=108 data-nosnippet>108</a>} |
| <a href=#109 id=109 data-nosnippet>109</a> |
| <a href=#110 id=110 data-nosnippet>110</a><span class="attr">#[cfg(test)] |
| <a href=#111 id=111 data-nosnippet>111</a></span><span class="kw">mod </span>tests { |
| <a href=#112 id=112 data-nosnippet>112</a> <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <a href=#113 id=113 data-nosnippet>113</a> |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="attr">#[test] |
| <a href=#115 id=115 data-nosnippet>115</a> </span><span class="kw">fn </span>original_changelog_url_creation() { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="kw">let </span>input = <span class="string">"2019-07-24-changelog-0.adoc"</span>; |
| <a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span>actual = create_original_changelog_url(input); |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="kw">let </span>expected = <span class="string">"https://rust-analyzer.github.io/thisweek/2019/07/24/changelog-0.html"</span>; |
| <a href=#119 id=119 data-nosnippet>119</a> <span class="macro">assert_eq!</span>(actual, expected); |
| <a href=#120 id=120 data-nosnippet>120</a> } |
| <a href=#121 id=121 data-nosnippet>121</a>}</code></pre></div></section></main></body></html> |
