Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 04:53:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Include a commit log summary in the changelog

Browse source
This commit is contained in:
Laurențiu Nicola 2021-02-12 19:52:51 +02:00
parent cf44953210
commit 8814d1368d
2 changed files with 40 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/dev/README.md
View file

@ -218,8 +218,7 @@ Release steps:
* makes a GitHub release * makes a GitHub release
* pushes VS Code extension to the marketplace * pushes VS Code extension to the marketplace
* create new changelog in `rust-analyzer.github.io` * create new changelog in `rust-analyzer.github.io`
* create `rust-analyzer.github.io/git.log` file with the log of merge commits since last release 2. While the release is in progress, fill in the changelog
2. While the release is in progress, fill-in the changelog using `git.log`
3. Commit & push the changelog 3. Commit & push the changelog
4. Tweet 4. Tweet
5. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's submodule. 5. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's submodule.

69
xtask/src/release.rs
View file

@ -1,3 +1,5 @@
use std::fmt::Write;
use xshell::{cmd, cp, pushd, read_dir, write_file}; use xshell::{cmd, cp, pushd, read_dir, write_file};
use crate::{codegen, date_iso, is_release_tag, project_root, Mode, Result}; use crate::{codegen, date_iso, is_release_tag, project_root, Mode, Result};
@ -24,34 +26,6 @@ impl ReleaseCmd {
let commit = cmd!("git rev-parse HEAD").read()?; let commit = cmd!("git rev-parse HEAD").read()?;
let changelog_n = read_dir(changelog_dir.as_path())?.len(); let changelog_n = read_dir(changelog_dir.as_path())?.len();
let contents = format!(
"\
= Changelog #{}
:sectanchors:
:page-layout: post
Commit: commit:{}[] +
Release: release:{}[]
== Sponsors
**Become a sponsor:** On https://opencollective.com/rust-analyzer/[OpenCollective] or
https://github.com/sponsors/rust-analyzer[GitHub Sponsors].
== New Features
* pr:[] .
== Fixes
== Internal Improvements
",
changelog_n, commit, today
);
let path = changelog_dir.join(format!("{}-changelog-{}.adoc", today, changelog_n));
write_file(&path, &contents)?;
for &adoc in [ for &adoc in [
"manual.adoc", "manual.adoc",
"generated_assists.adoc", "generated_assists.adoc",
@ -70,8 +44,43 @@ https://github.com/sponsors/rust-analyzer[GitHub Sponsors].
let prev_tag = tags.lines().filter(|line| is_release_tag(line)).last().unwrap(); let prev_tag = tags.lines().filter(|line| is_release_tag(line)).last().unwrap();
let git_log = cmd!("git log {prev_tag}..HEAD --merges --reverse").read()?; let git_log = cmd!("git log {prev_tag}..HEAD --merges --reverse").read()?;
let git_log_dst = website_root.join("git.log"); let mut git_log_summary = String::new();
write_file(git_log_dst, &git_log)?; for line in git_log.lines() {
let line = line.trim_start();
if let Some(p) = line.find(':') {
if let Ok(pr) = line[..p].parse::<u32>() {
writeln!(git_log_summary, "* pr:{}[]{}", pr, &line[p + 1..]).unwrap();
}
}
}
let contents = format!(
"\
= Changelog #{}
:sectanchors:
:page-layout: post
Commit: commit:{}[] +
Release: release:{}[]
== Sponsors
**Become a sponsor:** On https://opencollective.com/rust-analyzer/[OpenCollective] or
https://github.com/sponsors/rust-analyzer[GitHub Sponsors].
== New Features
{}
== Fixes
== Internal Improvements
",
changelog_n, commit, today, git_log_summary
);
let path = changelog_dir.join(format!("{}-changelog-{}.adoc", today, changelog_n));
write_file(&path, &contents)?;
Ok(()) Ok(())
} }