Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve build_and_release workflow #81

Open
bl4ckswordsman opened this issue Nov 13, 2024 · 0 comments · May be fixed by #82
Open

Improve build_and_release workflow #81

bl4ckswordsman opened this issue Nov 13, 2024 · 0 comments · May be fixed by #82
Labels
enhancement New feature or request

Comments

@bl4ckswordsman
Copy link
Owner

bl4ckswordsman commented Nov 13, 2024

Add a new workflow file(for testing purposes only)for a github action worflow that automatically generates release notes in a nice format from commit messages (and pr's too perhaps?). The solution should be simple and by default take into account commit message prefixes such as "chore:", "fix:", "feat:", "docs:", "docs(readme):" etc.

A similar automated solution should be implemented(using some other extension if needed. Otherwise in a simple way) to get all these release notes together in a single changelog md file, using a github action that automates the process in a simple way.

The github actions chosen from the GitHub actions marketplace should be fairly well-known, well built and fairly maintained.

The new file with these new workflows, should not actually be triggered on pr or such, but only manually on workflow_dispatch with the appropriate inputs(such as release versions etc). It shouldn't either make any actual changes or additions, only print out the expected release notes and/or full changelog.

@bl4ckswordsman bl4ckswordsman added the enhancement New feature or request label Nov 13, 2024
@bl4ckswordsman bl4ckswordsman added this to the v0.0.5 release milestone Nov 13, 2024
bl4ckswordsman added a commit that referenced this issue Nov 13, 2024
Fixes #81

Add a new GitHub Actions workflow to generate release notes and changelog.

* **New Workflow File**: Add `.github/workflows/generate_release_notes.yaml` to create a workflow for generating release notes and compiling a changelog.
* **Generate Release Notes**: Use `release-drafter/release-drafter@v5` action to generate release notes from commit messages and PRs.
* **Compile Changelog**: Use `actions/github-script@v6` to compile the generated release notes into a `CHANGELOG.md` file.
* **Manual Trigger**: Configure the workflow to be triggered manually using `workflow_dispatch` with inputs for release version and additional notes.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/bl4ckswordsman/disco-beacon/issues/81?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant