Unverified Commit 0b059fb5 authored by ysaito1001's avatar ysaito1001 Committed by GitHub
Browse files

Add support for changelog entry markdown files (#3763) 

## Motivation and Context
[RFC: File-per-change
changelog](https://smithy-lang.github.io/smithy-rs/design/rfcs/rfc0042_file_per_change_changelog.html#rfc-file-per-change-changelog)

## Description
This PR is the first of the two implementing the proposal outlined in
the RFC, and it focuses on the initial 4 bullets in the [Changes
checklist](https://smithy-lang.github.io/smithy-rs/design/rfcs/rfc0042_file_per_change_changelog.html#changes-checklist).
Crucially, this update does not modify the workflow for developers
regarding changelog entries (editing `CHANGELOG.next.toml` remains
necessary) or impact the `smithy-rs` CI process and our release
pipeline.

The PR introduces support for deserializing the following Markdown front
matter in the YAML format described in the RFC, e.g.
```
---
# Adding `aws-sdk-rust` here duplicates this entry into the SDK changelog.
applies_to: ["client", "server", "aws-sdk-rust"]
authors: ["author1", "author2"]
references: ["smithy-rs#1234", "aws-sdk-rust#1234"]
# The previous `meta` section is broken up into its constituents:
breaking: false
# This replaces "tada":
new_feature: false
bug_fix: false
---

Some message for the change.
```
These changelog entry Markdown files will be saved in the
`smithy-rs/.changelog` directory:
```
┌───────────┐                  
│ smithy-rs │                  
└─────┬─────┘                  
      │                        
      │    ┌───────────┐       
      ├────┤.changelog │       
           └─────┬─────┘       
                 │             
                 ├─────test1.md  
                 │ 
                 └─────test2.md 
```
For a concrete example, see a test
`end_to_end_changelog_entry_markdown_files` that directly converts from
`end_to_end_changelog` and uses Markdown files (the expected test
results remain the same).

The next PR is expected to
- add new subcommands to `changelogger` to a) create a Markdown file and
b) preview changelog entries pending to be released
- port existing `CHANGELOG.next.toml` at that time to individual
Markdown files
- update `sdk-lints` to disallow the existence of `CHANGELOG.next.toml`
- pass a directory path for `smithy-rs/.changelog` to `--source` (one
for
[split](https://github.com/smithy-lang/smithy-rs/blob/dc970b37386b155eced5d41262ce0a7fc4a34a91/tools/ci-scripts/generate-smithy-rs-release#L22)
and one for
[render](https://github.com/smithy-lang/smithy-rs/blob/dc970b37386b155eced5d41262ce0a7fc4a34a91/tools/ci-scripts/generate-smithy-rs-release#L22))
and to
[--source-to-truncate](https://github.com/smithy-lang/smithy-rs/blob/dc970b37386b155eced5d41262ce0a7fc4a34a91/tools/ci-scripts/generate-smithy-rs-release#L23C1-L23C47)

(the 4th bullet effectively does the cutover to the new changelog mode)

## Testing
- Added `parse_markdown` and `end_to_end_changelog_entry_markdown_files`
for testing new changelog format (the rest of the tests showing up in
the diff are moved from different places)
- Confirmed via [a release
dry-run](https://github.com/smithy-lang/smithy-rs/actions/runs/9947165056)
that this PR does not break the existing `smithy-rs` release process
- Confirmed that this PR does not break the use of `changelogger` in our
internal release process

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._
parent 8d23be13

tools/ci-build/changelogger/Cargo.lock

+20 −0
Original line number Original line Diff line number Diff line
@@ -997,6 +997,19 @@ dependencies = [ 
 "serde",

 "serde",

]

]





[[package]]

name = "serde_yaml"

version = "0.9.34+deprecated"

source = "registry+https://github.com/rust-lang/crates.io-index"

checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47"

dependencies = [

 "indexmap 2.2.6",

 "itoa",

 "ryu",

 "serde",

 "unsafe-libyaml",

]



[[package]]

[[package]]

name = "slab"

name = "slab"

version = "0.4.9"

version = "0.4.9"
@@ -1020,6 +1033,7 @@ dependencies = [ 
 "semver",

 "semver",

 "serde",

 "serde",

 "serde_json",

 "serde_json",

 "serde_yaml",

 "thiserror",

 "thiserror",

 "toml 0.5.11",

 "toml 0.5.11",

 "tracing",

 "tracing",
@@ -1329,6 +1343,12 @@ dependencies = [ 
 "tinyvec",

 "tinyvec",

]

]





[[package]]

name = "unsafe-libyaml"

version = "0.2.11"

source = "registry+https://github.com/rust-lang/crates.io-index"

checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861"



[[package]]

[[package]]

name = "url"

name = "url"

version = "2.5.0"

version = "2.5.0"

tools/ci-build/changelogger/src/render.rs

+197 −53
Original line number Original line Diff line number Diff line
@@ -10,12 +10,14 @@ use once_cell::sync::Lazy; 
use ordinal::Ordinal;

use ordinal::Ordinal;

use serde::Serialize;

use serde::Serialize;

use smithy_rs_tool_common::changelog::{

use smithy_rs_tool_common::changelog::{

    Changelog, HandAuthoredEntry, Reference, SdkModelChangeKind, SdkModelEntry, ValidationSet,

    Changelog, ChangelogLoader, HandAuthoredEntry, Reference, SdkModelChangeKind, SdkModelEntry,

    ValidationSet,

};

};

use smithy_rs_tool_common::git::{find_git_repository_root, Git, GitCLI};

use smithy_rs_tool_common::git::{find_git_repository_root, Git, GitCLI};

use smithy_rs_tool_common::versions_manifest::{CrateVersionMetadataMap, VersionsManifest};

use smithy_rs_tool_common::versions_manifest::{CrateVersionMetadataMap, VersionsManifest};

use std::env;

use std::env;

use std::fmt::Write;

use std::fmt::Write;

use std::fs;

use std::path::{Path, PathBuf};

use std::path::{Path, PathBuf};

use time::OffsetDateTime;

use time::OffsetDateTime;
@@ -244,8 +246,13 @@ fn render_table_row(columns: [&str; 2], out: &mut String) { 




fn load_changelogs(args: &RenderArgs) -> Result<Changelog> {

fn load_changelogs(args: &RenderArgs) -> Result<Changelog> {

    let mut combined = Changelog::new();

    let mut combined = Changelog::new();

    let loader = ChangelogLoader::default();

    for source in &args.source {

    for source in &args.source {

        let changelog = Changelog::load_from_file(source)

        let changelog = if source.is_dir() {

            loader.load_from_dir(source)

        } else {

            loader.load_from_file(source)

        }

        .map_err(|errs| anyhow::Error::msg(format!("failed to load {source:?}: {errs:#?}")))?;

        .map_err(|errs| anyhow::Error::msg(format!("failed to load {source:?}: {errs:#?}")))?;

        changelog.validate(ValidationSet::Render).map_err(|errs| {

        changelog.validate(ValidationSet::Render).map_err(|errs| {

            anyhow::Error::msg(format!(

            anyhow::Error::msg(format!(
@@ -321,8 +328,14 @@ fn update_changelogs( 
    update.push_str(&current);

    update.push_str(&current);

    std::fs::write(&args.changelog_output, update).context("failed to write rendered changelog")?;

    std::fs::write(&args.changelog_output, update).context("failed to write rendered changelog")?;





    std::fs::write(&args.source_to_truncate, EXAMPLE_ENTRY.trim())

    if args.source_to_truncate.is_dir() {

        .context("failed to truncate source")?;

        fs::remove_dir_all(&args.source_to_truncate)

            .and_then(|_| fs::create_dir(&args.source_to_truncate))

            .with_context(|| format!("failed to empty directory {:?}", &args.source_to_truncate))?;

    } else {

        fs::write(&args.source_to_truncate, EXAMPLE_ENTRY.trim())

            .with_context(|| format!("failed to truncate source {:?}", &args.source_to_truncate))?;

    }

    eprintln!("Changelogs updated!");

    eprintln!("Changelogs updated!");

    Ok(())

    Ok(())

}

}
@@ -494,11 +507,14 @@ fn render( 
#[cfg(test)]

#[cfg(test)]

mod test {

mod test {

    use super::{date_based_release_metadata, render, Changelog, ChangelogEntries, ChangelogEntry};

    use super::{date_based_release_metadata, render, Changelog, ChangelogEntries, ChangelogEntry};

    use smithy_rs_tool_common::changelog::ChangelogLoader;

    use smithy_rs_tool_common::{

    use smithy_rs_tool_common::{

        changelog::SdkAffected,

        changelog::SdkAffected,

        package::PackageCategory,

        package::PackageCategory,

        versions_manifest::{CrateVersion, CrateVersionMetadataMap},

        versions_manifest::{CrateVersion, CrateVersionMetadataMap},

    };

    };

    use std::fs;

    use tempfile::TempDir;

    use time::OffsetDateTime;

    use time::OffsetDateTime;





    fn render_full(entries: &[ChangelogEntry], release_header: &str) -> String {

    fn render_full(entries: &[ChangelogEntry], release_header: &str) -> String {
@@ -506,6 +522,174 @@ mod test { 
        format!("{header}{body}")

        format!("{header}{body}")

    }

    }





    const SMITHY_RS_EXPECTED_END_TO_END: &str = r#"v0.3.0 (January 4th, 2022)

==========================

**Breaking Changes:**

- :warning: (all, [smithy-rs#445](https://github.com/smithy-lang/smithy-rs/issues/445)) I made a major change to update the code generator



**New this release:**

- :tada: (all, [smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [aws-sdk#123](https://github.com/aws/aws-sdk/issues/123), @external-contrib, @other-external-dev) I made a change to update the code generator

- :tada: (all, [smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447), @external-contrib, @other-external-dev) I made a change to update the code generator



    **Update guide:**

    blah blah

- (all, [smithy-rs#200](https://github.com/smithy-lang/smithy-rs/issues/200), @another-contrib) I made a minor change



**Contributors**

Thank you for your contributions! ❤

- @another-contrib ([smithy-rs#200](https://github.com/smithy-lang/smithy-rs/issues/200))

- @external-contrib ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447))

- @other-external-dev ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447))



"#;



    const AWS_SDK_EXPECTED_END_TO_END: &str = r#"v0.1.0 (January 4th, 2022)

==========================

**Breaking Changes:**

- :warning: ([smithy-rs#445](https://github.com/smithy-lang/smithy-rs/issues/445)) I made a major change to update the AWS SDK



**New this release:**

- :tada: ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), @external-contrib) I made a change to update the code generator



**Service Features:**

- `aws-sdk-ec2` (0.12.0): Some API change

- `aws-sdk-s3` (0.14.0): Some new API to do X



**Service Documentation:**

- `aws-sdk-ec2` (0.12.0): Updated some docs



**Contributors**

Thank you for your contributions! ❤

- @external-contrib ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446))



"#;



    #[test]

    fn end_to_end_changelog_entry_markdown_files() {

        let temp_dir = TempDir::new().unwrap();

        let smithy_rs_entry1 = r#"---

applies_to: ["client", "server"]

authors: ["rcoh", "jdisanti"]

references: ["smithy-rs#445"]

breaking: true

new_feature: false

bug_fix: false

---

I made a major change to update the code generator

"#;

        let smithy_rs_entry2 = r#"---

applies_to: ["client", "server"]

authors: ["external-contrib", "other-external-dev"]

references: ["smithy-rs#446", "aws-sdk#123"]

breaking: false

new_feature: true

bug_fix: false

---

I made a change to update the code generator

"#;

        let smithy_rs_entry3 = r#"---

applies_to: ["client", "server"]

authors: ["another-contrib"]

references:  ["smithy-rs#200"]

breaking: false

new_feature: false

bug_fix: false

---

I made a minor change

"#;

        let aws_sdk_entry1 = r#"---

applies_to: ["aws-sdk-rust"]

authors: ["rcoh"]

references: ["smithy-rs#445"]

breaking: true

new_feature: false

bug_fix: false

---

I made a major change to update the AWS SDK

"#;

        let aws_sdk_entry2 = r#"---

applies_to: ["aws-sdk-rust"]

authors: ["external-contrib"]

references: ["smithy-rs#446"]

breaking: false

new_feature: true

bug_fix: false

---

I made a change to update the code generator

"#;

        let smithy_rs_entry4 = r#"---

applies_to: ["client", "server"]

authors: ["external-contrib", "other-external-dev"]

references: ["smithy-rs#446", "smithy-rs#447"]

breaking: false

new_feature: true

bug_fix: false

---

I made a change to update the code generator



**Update guide:**

blah blah

"#;



        // We won't handwrite changelog entries for model updates, and they are still provided in

        // the TOML format.

        let model_updates = r#"

[[aws-sdk-model]]

module = "aws-sdk-s3"

version = "0.14.0"

kind = "Feature"

message = "Some new API to do X"



[[aws-sdk-model]]

module = "aws-sdk-ec2"

version = "0.12.0"

kind = "Documentation"

message = "Updated some docs"



[[aws-sdk-model]]

module = "aws-sdk-ec2"

version = "0.12.0"

kind = "Feature"

message = "Some API change"

        "#;



        [

            smithy_rs_entry1,

            smithy_rs_entry2,

            smithy_rs_entry3,

            aws_sdk_entry1,

            aws_sdk_entry2,

            smithy_rs_entry4,

        ]

        .iter()

        .enumerate()

        .for_each(|(i, contents)| {

            let changelog_entry_markdown_file = temp_dir.path().join(format!("test{i}.md"));

            fs::write(&changelog_entry_markdown_file, contents.as_bytes()).unwrap();

        });



        let mut changelog = ChangelogLoader::default()

            .load_from_dir(temp_dir.path())

            .expect("valid changelog");



        changelog.merge(

            ChangelogLoader::default()

                .parse_str(model_updates)

                .expect("valid changelog"),

        );



        let ChangelogEntries {

            aws_sdk_rust,

            smithy_rs,

        } = changelog.into();



        let smithy_rs_rendered = render_full(&smithy_rs, "v0.3.0 (January 4th, 2022)");

        pretty_assertions::assert_str_eq!(SMITHY_RS_EXPECTED_END_TO_END, smithy_rs_rendered);



        let aws_sdk_rendered = render_full(&aws_sdk_rust, "v0.1.0 (January 4th, 2022)");

        pretty_assertions::assert_str_eq!(AWS_SDK_EXPECTED_END_TO_END, aws_sdk_rendered);

    }



    #[test]

    #[test]

    fn end_to_end_changelog() {

    fn end_to_end_changelog() {

        let changelog_toml = r#"

        let changelog_toml = r#"
@@ -568,61 +752,19 @@ version = "0.12.0" 
kind = "Feature"

kind = "Feature"

message = "Some API change"

message = "Some API change"

        "#;

        "#;

        let changelog: Changelog = Changelog::parse_str(changelog_toml).expect("valid changelog");

        let changelog: Changelog = ChangelogLoader::default()

            .parse_str(changelog_toml)

            .expect("valid changelog");

        let ChangelogEntries {

        let ChangelogEntries {

            aws_sdk_rust,

            aws_sdk_rust,

            smithy_rs,

            smithy_rs,

        } = changelog.into();

        } = changelog.into();





        let smithy_rs_rendered = render_full(&smithy_rs, "v0.3.0 (January 4th, 2022)");

        let smithy_rs_rendered = render_full(&smithy_rs, "v0.3.0 (January 4th, 2022)");

        let smithy_rs_expected = r#"

        pretty_assertions::assert_str_eq!(SMITHY_RS_EXPECTED_END_TO_END, smithy_rs_rendered);

v0.3.0 (January 4th, 2022)

==========================

**Breaking Changes:**

- :warning: (all, [smithy-rs#445](https://github.com/smithy-lang/smithy-rs/issues/445)) I made a major change to update the code generator



**New this release:**

- :tada: (all, [smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [aws-sdk#123](https://github.com/aws/aws-sdk/issues/123), @external-contrib, @other-external-dev) I made a change to update the code generator

- :tada: (all, [smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447), @external-contrib, @other-external-dev) I made a change to update the code generator



    **Update guide:**

    blah blah

- (all, [smithy-rs#200](https://github.com/smithy-lang/smithy-rs/issues/200), @another-contrib) I made a minor change



**Contributors**

Thank you for your contributions! ❤

- @another-contrib ([smithy-rs#200](https://github.com/smithy-lang/smithy-rs/issues/200))

- @external-contrib ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447))

- @other-external-dev ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), [smithy-rs#447](https://github.com/smithy-lang/smithy-rs/issues/447))



"#

        .trim_start();

        pretty_assertions::assert_str_eq!(smithy_rs_expected, smithy_rs_rendered);





        let aws_sdk_rust_rendered = render_full(&aws_sdk_rust, "v0.1.0 (January 4th, 2022)");

        let aws_sdk_rust_rendered = render_full(&aws_sdk_rust, "v0.1.0 (January 4th, 2022)");

        let aws_sdk_expected = r#"

        pretty_assertions::assert_str_eq!(AWS_SDK_EXPECTED_END_TO_END, aws_sdk_rust_rendered);

v0.1.0 (January 4th, 2022)

==========================

**Breaking Changes:**

- :warning: ([smithy-rs#445](https://github.com/smithy-lang/smithy-rs/issues/445)) I made a major change to update the AWS SDK



**New this release:**

- :tada: ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446), @external-contrib) I made a change to update the code generator



**Service Features:**

- `aws-sdk-ec2` (0.12.0): Some API change

- `aws-sdk-s3` (0.14.0): Some new API to do X



**Service Documentation:**

- `aws-sdk-ec2` (0.12.0): Updated some docs



**Contributors**

Thank you for your contributions! ❤

- @external-contrib ([smithy-rs#446](https://github.com/smithy-lang/smithy-rs/issues/446))



"#

        .trim_start();

        pretty_assertions::assert_str_eq!(aws_sdk_expected, aws_sdk_rust_rendered);

    }

    }





    #[test]

    #[test]
@@ -670,7 +812,9 @@ meta = { breaking = false, tada = true, bug = false } 
references = ["smithy-rs#446"]

references = ["smithy-rs#446"]

author = "rcoh"

author = "rcoh"

"#;

"#;

        let changelog: Changelog = Changelog::parse_str(sample).expect("valid changelog");

        let changelog: Changelog = ChangelogLoader::default()

            .parse_str(sample)

            .expect("valid changelog");

        let ChangelogEntries {

        let ChangelogEntries {

            aws_sdk_rust: _,

            aws_sdk_rust: _,

            smithy_rs,

            smithy_rs,

tools/ci-build/changelogger/src/split.rs

+13 −3
Original line number Original line Diff line number Diff line
@@ -5,7 +5,7 @@ 




use anyhow::{Context, Result};

use anyhow::{Context, Result};

use clap::Parser;

use clap::Parser;

use smithy_rs_tool_common::changelog::Changelog;

use smithy_rs_tool_common::changelog::{Changelog, ChangelogLoader};

use smithy_rs_tool_common::git::{find_git_repository_root, Git, GitCLI};

use smithy_rs_tool_common::git::{find_git_repository_root, Git, GitCLI};

use std::path::{Path, PathBuf};

use std::path::{Path, PathBuf};

use std::{env, fs, mem};

use std::{env, fs, mem};
@@ -14,6 +14,8 @@ use std::{env, fs, mem}; 
// SDK changelog entries, but small enough that the SDK changelog file

// SDK changelog entries, but small enough that the SDK changelog file

// doesn't get too long.

// doesn't get too long.

const MAX_ENTRY_AGE: usize = 5;

const MAX_ENTRY_AGE: usize = 5;

// TODO(file-per-change-changelog): Remove `INTERMEDIATE_SOURCE_HEADER` once we have switched over

//  to the new markdown format.

const INTERMEDIATE_SOURCE_HEADER: &str =

const INTERMEDIATE_SOURCE_HEADER: &str =

    "# This is an intermediate file that will be replaced after automation is complete.\n\

    "# This is an intermediate file that will be replaced after automation is complete.\n\

     # It will be used to generate a changelog entry for smithy-rs.\n\

     # It will be used to generate a changelog entry for smithy-rs.\n\
@@ -42,14 +44,20 @@ pub struct SplitArgs { 
}

}





pub fn subcommand_split(args: &SplitArgs) -> Result<()> {

pub fn subcommand_split(args: &SplitArgs) -> Result<()> {

    let combined_changelog = Changelog::load_from_file(&args.source).map_err(|errs| {

    let loader = ChangelogLoader::default();

    let combined_changelog = if args.source.is_dir() {

        loader.load_from_dir(&args.source)

    } else {

        loader.load_from_file(&args.source)

    }

    .map_err(|errs| {

        anyhow::Error::msg(format!(

        anyhow::Error::msg(format!(

            "cannot split changelogs with changelog errors: {:#?}",

            "cannot split changelogs with changelog errors: {:#?}",

            errs

            errs

        ))

        ))

    })?;

    })?;

    let current_sdk_changelog = if args.destination.exists() {

    let current_sdk_changelog = if args.destination.exists() {

        Changelog::load_from_file(&args.destination).map_err(|errs| {

        loader.load_from_file(&args.destination).map_err(|errs| {

            anyhow::Error::msg(format!(

            anyhow::Error::msg(format!(

                "failed to load existing SDK changelog entries: {:#?}",

                "failed to load existing SDK changelog entries: {:#?}",

                errs

                errs
@@ -65,6 +73,8 @@ pub fn subcommand_split(args: &SplitArgs) -> Result<()> { 
    );

    );

    let sdk_changelog = merge_sdk_entries(current_sdk_changelog, new_sdk_entries);

    let sdk_changelog = merge_sdk_entries(current_sdk_changelog, new_sdk_entries);





    // TODO(file-per-change-changelog): Remove writing to `INTERMEDIATE_SOURCE_HEADER` once we have

    //  switched over to the new markdown format.

    write_entries(&args.source, INTERMEDIATE_SOURCE_HEADER, &smithy_rs_entries)

    write_entries(&args.source, INTERMEDIATE_SOURCE_HEADER, &smithy_rs_entries)

        .context("failed to write source")?;

        .context("failed to write source")?;

    write_entries(&args.destination, DEST_HEADER, &sdk_changelog)

    write_entries(&args.destination, DEST_HEADER, &sdk_changelog)

tools/ci-build/sdk-lints/Cargo.lock

+20 −0
Original line number Original line Diff line number Diff line
@@ -930,6 +930,19 @@ dependencies = [ 
 "serde",

 "serde",

]

]





[[package]]

name = "serde_yaml"

version = "0.9.34+deprecated"

source = "registry+https://github.com/rust-lang/crates.io-index"

checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47"

dependencies = [

 "indexmap 2.2.6",

 "itoa",

 "ryu",

 "serde",

 "unsafe-libyaml",

]



[[package]]

[[package]]

name = "slab"

name = "slab"

version = "0.4.9"

version = "0.4.9"
@@ -953,6 +966,7 @@ dependencies = [ 
 "semver",

 "semver",

 "serde",

 "serde",

 "serde_json",

 "serde_json",

 "serde_yaml",

 "thiserror",

 "thiserror",

 "toml 0.5.11",

 "toml 0.5.11",

 "tracing",

 "tracing",
@@ -1241,6 +1255,12 @@ dependencies = [ 
 "tinyvec",

 "tinyvec",

]

]





[[package]]

name = "unsafe-libyaml"

version = "0.2.11"

source = "registry+https://github.com/rust-lang/crates.io-index"

checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861"



[[package]]

[[package]]

name = "url"

name = "url"

version = "2.5.0"

version = "2.5.0"

tools/ci-build/sdk-lints/src/changelog.rs

+7 −2
Original line number Original line Diff line number Diff line
@@ -6,7 +6,7 @@ 
use crate::lint::LintError;

use crate::lint::LintError;

use crate::{repo_root, Check, Lint};

use crate::{repo_root, Check, Lint};

use anyhow::Result;

use anyhow::Result;

use smithy_rs_tool_common::changelog::{Changelog, ValidationSet};

use smithy_rs_tool_common::changelog::{ChangelogLoader, ValidationSet};

use std::path::{Path, PathBuf};

use std::path::{Path, PathBuf};





pub(crate) struct ChangelogNext;

pub(crate) struct ChangelogNext;
@@ -30,9 +30,14 @@ impl Check for ChangelogNext { 
    }

    }

}

}





// TODO(file-per-change-changelog): Use `.load_from_dir` to read from the `.changelog` directory

//  and run the validation only when the directory has at least one changelog entry file, otherwise

//  a default constructed `ChangeLog` won't pass the validation.

/// Validate that `CHANGELOG.next.toml` follows best practices

/// Validate that `CHANGELOG.next.toml` follows best practices

fn check_changelog_next(path: impl AsRef<Path>) -> std::result::Result<(), Vec<LintError>> {

fn check_changelog_next(path: impl AsRef<Path>) -> std::result::Result<(), Vec<LintError>> {

    let parsed = Changelog::load_from_file(path).map_err(|e| vec![LintError::via_display(e)])?;

    let parsed = ChangelogLoader::default()

        .load_from_file(path)

        .map_err(|e| vec![LintError::via_display(e)])?;

    parsed

    parsed

        .validate(ValidationSet::Development)

        .validate(ValidationSet::Development)

        .map_err(|errs| {

        .map_err(|errs| {