Automatically Generate Release Notes

[Michaelpalacce]

Description

Investigate what's the best way to generate release notes.

Additional Context

Some options

• https://github.com/release-drafter/release-drafter
• https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

[Hristo-Cholakov]

name: Generate Release Notes

on:
  push:
    branches:
      - main

jobs:
  generate-release-notes:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Check if conventional-changelog-cli is installed
        id: check-install
        run: |
          if ! command -v conventional-changelog &> /dev/null; then
            echo "conventional-changelog-cli is not installed."
            echo "Installing it now..."
            npm install -g conventional-changelog-cli
          else
            echo "conventional-changelog-cli is already installed."
          fi
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

      - name: Generate Release Notes
        if: steps.check-install.outcome == 'success'
        run: |
          conventional-changelog -p angular -i CHANGELOG.md -s
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

      - name: Commit and push changes
        if: steps.check-install.outcome == 'success'
        run: |
          git config --global user.email "svc-wwcoe-ci-admin@vmware.com"
          git config --global user.name "WWCoE CI admin"
          git add CHANGELOG.md
          git commit -m "chore(release): Update changelog [skip ci]"
          git push
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

[Michaelpalacce]

@VenelinBakalov do you think this is still a priority?

[VenelinBakalov]

@Michaelpalacce I wouldn't say priority, but I think it is still a topic of interest.

[Michaelpalacce]

I am not sure how to test this honestly 😄

[VenelinBakalov]

well...I can suggest one not pretty but working method...in prod kinda.
Commit a Workflow that has just the name and the following property:

name:

on:
workflow_dispatch:

https://github.com/vmware/build-tools-for-vmware-aria/blob/main/.github/workflows/stale.yml

Once this is in master, the workflow_dispatch will enable you to select the action and run it manually. You can then create a branch with the code suggested by @Hristo-Cholakov and then you can manually run the workflow from that branch:

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[VenelinBakalov]

Issue is still valid

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[VenelinBakalov]

Still valid

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[VenelinBakalov]

Not stale

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.