Giter Club home page Giter Club logo

relno-action's Introduction

Contributors Forks Stargazers MIT License Issues Issues Closed


relno-action

GitHub Action to generate release notes from pull requests. Using Relno.

Screenshots

screenshot

Documentation

Documentation is available at Relno Docs.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

relno-action's People

Contributors

ppodds avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

relno-action's Issues

Support breaking change commit message

Describe the solution you'd like
Add a Breaking change type and the generator can generate it automatically.

e.g.

feat!: a breaking change commit (#4) =>

### Breaking Changes

- a breaking change commit (#4)

Describe alternatives you've considered
None

Additional context
None

Support contributor list generation

Is your feature request related to a problem? Please describe.
The current design cannot generate a contributor list.

Describe the solution you'd like
Implement a plugin system and lifecycle hook to collect contributor information.

Describe alternatives you've considered
Add a contributor section like changes section

Additional context
None

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/codeql-analysis.yml
  • actions/checkout v4
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/release.yml
  • actions/checkout v4
  • actions/setup-node v4
  • JasonEtco/build-and-tag-action v2
.github/workflows/unit-test.yml
  • actions/checkout v4
  • actions/setup-node v4
npm
package.json
  • @actions/core ^1.10.1
  • @actions/github ^6.0.0
  • relno ^1.0.0
  • semver ^7.5.4
  • simple-git ^3.21.0
  • @jest/globals ^29.7.0
  • @types/node ^20.10.4
  • @types/semver ^7.5.6
  • @typescript-eslint/eslint-plugin ^6.13.2
  • @typescript-eslint/parser ^6.13.2
  • @vercel/ncc ^0.38.1
  • eslint ^8.55.0
  • eslint-plugin-github ^4.10.1
  • eslint-plugin-jest ^27.6.0
  • husky ^8.0.3
  • jest ^29.7.0
  • lint-staged ^15.2.0
  • prettier ^3.1.0
  • relno-plugin-contributor 1.0.0
  • ts-jest ^29.1.1
  • ts-node ^10.9.1
  • typescript ^5.3.3
  • pnpm 8.11.0

  • Check this box to trigger a request for Renovate to run again on this repository

Improve section tag syntax

Is your feature request related to a problem? Please describe.

The section tag syntax %% tagName %% is confusing.
It looks like a single interpolation tag and it's hard to realize that the tags are used in pairs.

By reading the example, I have no idea how the section tags work.
All I see are 4 independent section tags instead of 2 sections:

Describe the solution you'd like

Make open tag and close tag explicitly so that it's obvious where the section is.

Also, make the example more readable by inserting necessary newlines.

Add date format macro

Is your feature request related to a problem? Please describe.
I can't generate the format date in the current version.

Describe the solution you'd like
Add a macro to format the date string.

Describe alternatives you've considered
None

Additional context
None

Roadmap

Roadmap

Check this branch for the current developing progress.

Features

The features below will be added in the next major release.

  • Plugin system
  • Fully configurable commit message parser
  • TypeScript config file
  • Tag Syntax improve

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.