Skip to content
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
12 changes: 8 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name: Release

on:
release:
types: [created]
push:
tags:
- '[0-9]+\.[0-9]+\.[0-9]+'

jobs:

Expand Down Expand Up @@ -43,9 +44,12 @@ jobs:
rrp \
bash -c "/ros_release_python/scripts/ros_release_python pip"

- name: Upload assets to release
- name: Create Release with Assets
run: |
gh release upload ${{ github.event.release.tag_name }} dist/*
gh release create "${{ github.ref_name }}" \
--title "${{ github.ref_name }}" \
--generate-notes \
dist/*
env:
GH_TOKEN: ${{ github.token }}

Expand Down
27 changes: 12 additions & 15 deletions release_playbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,15 @@ This playbook outlines the steps to release a new version of the `vcs2l` project
git push origin main
```

## 2. Tagging the release
After merging the PR, create a new tag for the release using the following commands:

```bash
git checkout main
git tag x.y.z
git push origin x.y.z
```

## 3. Publishing the release on GitHub
* Navigate to the [Releases](https://github.com/ros-infrastructure/vcs2l/releases/new) page, and select the tag you just pushed.
* Fill in the release title as `x.y.z`.
* Create the release notes by using the `Generate release notes` button.
* Publish the release by setting it as the latest release.
* This will automatically trigger the GitHub Actions workflow to publish the package to PyPI.
## 2. Tagging the release and automated publishing
* After merging the PR, create a new tag for the repository using the following commands:

```bash
git checkout main
git tag x.y.z
git push origin x.y.z
```
* Pushing the tag will automatically create a GitHub release with assets - `*.whl` and `*.tar.gz`.
The release notes will be generated automatically based on the merged PRs since the last release.

* This would also publish the package onto PyPI with the newly created version.