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

ci: automate releases #120

Merged
merged 3 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Release
on: # yamllint disable-line rule:truthy
push:
tags:
- 'v*'

jobs:
create-release:
name: Create Release
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
repository-projects: write

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Create Release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref_name }}
release_name: Release ${{ github.ref_name }}
body: |
- Commit: ${{ github.sha }}
draft: false
prerelease: false
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [How to Run](#251-how-to-run)
- [2.6. Sanitizers](#26-sanitizers)
- [2.7. Coverage](#27-coverage)
- [3. Releases](#3-releases)

## 1. Development Environment

Expand Down Expand Up @@ -334,3 +335,19 @@ For a reference implementation, see the test setup in `//examples:unit_test`. Th
#### 2.7.3. ToDo - Baseline

A baseline mechanism for coverage is not yet implemented but will be added in the future.

## 3. Releases

A new release is automatically created for every push to a tag that matches the pattern `v*`."

To create a tag use the command:

```bash
git tag v<release version>
```

After creating the tag locally, push it to the remote repo.

```bash
git push origin v<release version>
```
Loading