https://github.com/chrisllontop/gh-release-sync
Automate the updating of version of files based on Github release tags.
https://github.com/chrisllontop/gh-release-sync
github-releases js release rust version-manager
Last synced: 3 months ago
JSON representation
Automate the updating of version of files based on Github release tags.
- Host: GitHub
- URL: https://github.com/chrisllontop/gh-release-sync
- Owner: chrisllontop
- Created: 2024-04-19T23:23:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T08:10:50.000Z (over 1 year ago)
- Last Synced: 2025-01-16T08:52:22.618Z (over 1 year ago)
- Topics: github-releases, js, release, rust, version-manager
- Language: Rust
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Release Sync
`gh-release-sync` is a GitHub Action designed to automate the updating of version files in projects based on GitHub release tags. This action facilitates maintaining synchronization of project version files with release versions, enhancing version tracking and management.
## Features
- **Automatic Update**: Automatically updates the version file based on the GitHub tag.
- **Easy Integration**: Easily integrates into any CI/CD workflow using GitHub Actions.
## Prerequisites
Before using `gh-release-sync`, ensure that your project uses version tags following the semantic format `vMAJOR.MINOR.PATCH` (e.g., `v1.0.0` or `v1.0.0-beta1`).
## Supported Languages
| Language | Support |
|----------|--------------------|
| Rust | :white_check_mark: |
| JavaScript (js) | :white_check_mark: |
| Others | :x: (Not supported at this time) |
## Usage
To use this action, include it in your GitHub Actions workflow. Below is an example of how to set up the action in your `.github/workflows/release.yml` file:
```yaml
name: Update Project Version on Release
on:
release:
types: [created]
jobs:
update-version:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: chrisllontop/gh-release-sync@v1
with:
lang: 'js' # Or 'rust', depending on the language of your project.
- name: Commit changes
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: 'Automatically update version file'
```