Skip to content

Commit

Permalink
Use tool to generate changelogs.
Browse files Browse the repository at this point in the history
This commit uses antsibull-changelog to generate changelogs for each
release. The CHANGELOG.rst file generated in this process will serve as
the body of the release. The source tarball is attached as an artifact.
  • Loading branch information
Christopher Palmer-Richez committed Aug 2, 2024
1 parent b9f5ae8 commit d7f9665
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 7 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Release
on:
push:
tags:
- v*

tags-ignore:
- "*-alpha"
- "*-beta"

jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- name: Install antibull-changelog
run: pip install ansibull-changelog

- name: Generate changelog
run: ansibull-changelog release

- name: Build collection tarball
run: ansible-galaxy collection build

- name: Get version string
shell: echo "VERSION=${GITHUB_REF_NAME:1}" >> "$GITHUB_ENV"

- uses: ncipollo/release-action@v1
with:
artifacts:
- crichez-secureboot-${{ env.VERSION }}.tar.gz
body_file: CHANGELOG.rst
13 changes: 6 additions & 7 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
ancestor: null
releases:
1.0.0:
release_date: "2024-08-02"
fragments:
- Initial release
changes:
release_summary: Initial release
fragments:
- Initial release

Check failure on line 7 in changelogs/changelog.yaml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[indentation]

Wrong indentation: expected 6 but found 4
objects:
role:
- name: uki_config
description: Configure kernel-install to use UKIs
namespace: null
- description: Configure kernel-install to use UKIs

Check failure on line 10 in changelogs/changelog.yaml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[indentation]

Wrong indentation: expected 8 but found 6
name: uki_config
namespace: null
release_date: '2024-08-02'
37 changes: 37 additions & 0 deletions changelogs/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
add_plugin_period: true
changelog_filename_template: ../CHANGELOG.rst
changelog_filename_version_depth: 0
changelog_nice_yaml: false
changelog_sort: alphanumerical
changes_file: changelog.yaml
changes_format: combined
ignore_other_fragment_extensions: true
keep_fragments: false
mention_ancestor: true
new_plugins_after_name: removed_features
notesdir: fragments
output_formats:
- rst

Check failure on line 14 in changelogs/config.yaml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[indentation]

Wrong indentation: expected at least 1
prelude_section_name: release_summary
prelude_section_title: Release Summary
sanitize_changelog: true
sections:
- - major_changes

Check failure on line 19 in changelogs/config.yaml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[indentation]

Wrong indentation: expected at least 1
- Major Changes
- - minor_changes
- Minor Changes
- - breaking_changes
- Breaking Changes / Porting Guide
- - deprecated_features
- Deprecated Features
- - removed_features
- Removed Features (previously deprecated)
- - security_fixes
- Security Fixes
- - bugfixes
- Bugfixes
- - known_issues
- Known Issues
title: Crichez.Secureboot
trivial_section_name: trivial
use_fqcn: true

0 comments on commit d7f9665

Please sign in to comment.