Skip to content

Helper for handling release notes #28

Open
@trevordevore

Description

@trevordevore

It would be nice if there was a standard way of logging which changes you have made during the current development cycle. When it comes time to package the application a release notes file could be created with a list of all of the changes.

One option is to have a folder where individual files describing each change are stored. Or perhaps just a single file with a list of all changes. One approach would be a structure like this:

  • build
  • app
  • levure
  • change log
    • current.md
    • v1.0.0-3.md
    • v1.0.1-8.md

current.md would have the list of changes made during the current dev cycle. When you release a version then current.md would be renamed using the current version and build number. A new, empty current.md file would be created.

The format of current.md might look like this:

# Features
- A feature I added

# Changes
- A change that was made

# Bug Fixes
- A bug that was fixed

There could be an API available in the IDE for adding a release note.

appAddReleaseNote "I fixed this bug", "Bug Fixes"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions