Skip to content

Empty remarks configuration option#122

Merged
max-ieremenko merged 4 commits intorelease/3.8.0from
feature/empty_remarks
Sep 13, 2025
Merged

Empty remarks configuration option#122
max-ieremenko merged 4 commits intorelease/3.8.0from
feature/empty_remarks

Conversation

@max-ieremenko
Copy link
Owner

New configuration option to manage empty remarks.md

appsettings.json

If keepEmptyFile is true (by default), the tool automatically creates an empty remarks.md for each package in the repository; otherwise, remarks.md will be deleted if empty.

  "repository": {
    "remarks.md": {
      "keepEmptyFile": true|false
    }
  }

Update nuget.org-readme-template.txt and npmjs.com-readme-template.txt to remove Remarks section from the package readme.md, if remarks are empty

{%- if Remarks -%}
Remarks
-----------
{{Remarks}}

{%- endif -%}

The described changes should be applied manually to the existing configuration, if necessary.

@max-ieremenko max-ieremenko merged commit d9c85c6 into release/3.8.0 Sep 13, 2025
2 checks passed
@max-ieremenko max-ieremenko deleted the feature/empty_remarks branch September 13, 2025 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant