Jeconias / changelog

Read your README and copy the last information about changes for the new tag/release.

Github Action Changelog

Read your README and copy the last information about changes for the new tag/release.

How to use

Create the README file on the repository and add the changelog structure. Your struct should seem with: (Ignore "\" on the example)

...

## Changelog

\<!-- Version start @@ {"version": "v0.1.1", "tagtitle": "..."} --> Start of the last changelog

- ### v0.1.1

  - The Changelog action will capture the text between `<!-- Version start -->` and `<!-- Version end -->`;
  - You can add `@@` and a JSON after to receive it on output;
  - See raw this file for a real example.

\<!-- Version end --> # End of the last changelog

- ### v0.1.0

  - any text

Workflow example

steps:
  - name: Read the README.md
    id: changelog
    uses: Jeconias/changelog@v1.3
    with:
      path: "./README.md" # The path to read a README.md file. (Optional)
  - name: Showing the last changelog
    run: echo "${{steps.ID.outputs.changelog}} | ${{steps.ID.outputs.version}}"

Full example

Changelog

• v0.1.4

  • Fix README.

• v0.1.3

  • Fix example.

• v0.1.2

  • Fix README and added a condition to verify if should create a new release on workflow.

• v0.1.1

  • Fix imports of main.ts
  • Updated main.yml to use the Changelog Action to reading the README.md and create a release.

• v0.1.0

  • Initial