https://github.com/leoweyr/github-release-workflow

Streamline your software delivery with a production-ready engineering workflow. Automated semantic versioning, changelog generation (via git-cliff), and GitHub release publishing.
https://github.com/leoweyr/github-release-workflow

automated-release changelog-generator ci-cd conventional-commits devops engineering-workflow git-cliff github-actions pipeline production-ready release-automation reusable-workflows sematic-release software-delivery

Last synced: 6 days ago
JSON representation

Streamline your software delivery with a production-ready engineering workflow. Automated semantic versioning, changelog generation (via git-cliff), and GitHub release publishing.

• Host: GitHub
• URL: https://github.com/leoweyr/github-release-workflow
• Owner: leoweyr
• License: mit
• Created: 2026-03-20T03:58:17.000Z (20 days ago)
• Default Branch: develop
• Last Pushed: 2026-03-29T06:32:38.000Z (11 days ago)
• Last Synced: 2026-03-29T08:30:38.819Z (11 days ago)
• Topics: automated-release, changelog-generator, ci-cd, conventional-commits, devops, engineering-workflow, git-cliff, github-actions, pipeline, production-ready, release-automation, reusable-workflows, sematic-release, software-delivery
• Homepage:
• Size: 30.3 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![github-release-workflow](https://socialify.git.ci/leoweyr/github-release-workflow/image?description=1&font=KoHo&forks=1&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fleoweyr%2Fgithub-release-workflow%2Frefs%2Fheads%2Fdevelop%2Fassets%2Ficon.svg&name=1&owner=1&pattern=Formal+Invitation&pulls=1&stargazers=1&theme=Light)

![Usage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fabacus.jasoncameron.dev%2Fget%2Fleoweyr%2Fgithub-release-workflow-usage&query=%24.value&label=Usage&color=blue&suffix=%20times)

![Used by Stats](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/leoweyr/0575adecfc13c95f281dfccfe5b76063/raw/github-release-workflow-used-by-stats.json)

> [!IMPORTANT]

> To ensure changelogs are generated correctly, all git commit messages must follow the **[Conventional Commits](https://www.conventionalcommits.org/)** specification.

>

> Also, you must go to your repository **Settings > Actions > General > Workflow permissions** and enable **"Allow GitHub Actions to create and approve pull requests"**, otherwise the automated release process will fail.

## 🚀 Instant Magic for Your Repository!!!

Add professional release automation to your personal project with a single step:

**Copy the `prepare-release.yml` and `publish-release.yml` files from `.github/workflows` into your project's `.github/workflows` directory.**

✨ That's it! Your repository is now enchanted.

## ⚙ How It Works

This workflow streamlines your release process into a few simple steps:

1.  **Tag Your Release**: On your development branch (separate from `master` or `main`), create a git tag with a `v` prefix (e.g., `v1.0.0`).

    ```bash

    git tag v1.0.0

    ```

2.  **Push the Tag**: Push the tag to GitHub.

    ```bash

    git push origin v1.0.0

    ```

3.  **Automated Magic**: GitHub Actions will automatically:

    *   Generate a changelog based on your conventional commits.

    *   Create a specific release branch.

    *   Open a Pull Request to your default branch (e.g., `master`).

4.  **Review and Merge**: Review the Pull Request created by the bot.

    *   **Do not modify the Pull Request title or body**, as they are used for the release metadata.

    *   Merge the Pull Request.

    *   The workflow will automatically create a GitHub Release for you.