From 5af921e8d99aca3aeb9524da1a74014d036a5226 Mon Sep 17 00:00:00 2001 From: Felix Fontein <felix@fontein.de> Date: Fri, 9 Feb 2024 13:08:50 +0100 Subject: [PATCH] Add MarkDown changelog and use it by default (#7941) Add MarkDown changelog and use it by default. --- CHANGELOG.md | 5 +++++ CHANGELOG.md.license | 3 +++ README.md | 2 +- changelogs/config.yaml | 3 +++ 4 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md create mode 100644 CHANGELOG.md.license diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..b35c52441b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Placeholder changelog + +This file is a placeholder; a version-specific `CHANGELOG-vX.md` will be generated during releases from fragments +under `changelogs/fragments`. On release branches once a release has been created, consult the branch's version-specific +file for changes that have occurred in that branch. diff --git a/CHANGELOG.md.license b/CHANGELOG.md.license new file mode 100644 index 0000000000..edff8c7685 --- /dev/null +++ b/CHANGELOG.md.license @@ -0,0 +1,3 @@ +GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +SPDX-License-Identifier: GPL-3.0-or-later +SPDX-FileCopyrightText: Ansible Project diff --git a/README.md b/README.md index f4f3647f5e..96b3c952db 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma ## Release notes -See the [changelog](https://github.com/ansible-collections/community.general/blob/main/CHANGELOG.rst). +See the [changelog](https://github.com/ansible-collections/community.general/blob/main/CHANGELOG.md). ## Roadmap diff --git a/changelogs/config.yaml b/changelogs/config.yaml index 52e101e11f..23afe36d29 100644 --- a/changelogs/config.yaml +++ b/changelogs/config.yaml @@ -12,6 +12,9 @@ mention_ancestor: true flatmap: true new_plugins_after_name: removed_features notesdir: fragments +output_formats: + - md + - rst prelude_section_name: release_summary prelude_section_title: Release Summary sections: