Skip to content

Feat/yak release #39

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.

Sign up for GitHub

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

Merged
iliasedelkin merged 2 commits into from
Jun 23, 2025
Merged

Feat/yak release #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdde222
Update documentation with release instructions
iliasedelkin Jun 23, 2025
ae21059
Update documentation
iliasedelkin Jun 23, 2025
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
15 changes: 10 additions & 5 deletions .github/workflows/yak-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,9 @@ jobs:
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ env.TAG_NAME }}
name: "Release ${{ env.TAG_NAME }}"
name: "${{ env.TAG_NAME }}"
body: |
## Release ${{ env.TAG_NAME }}
## ${{ env.TAG_NAME }}

**Version:** ${{ env.VERSION }}

Expand All @@ -192,12 +192,17 @@ jobs:
- Package file: `${{ env.YAK_PACKAGE_NAME }}`

### Installation
Install directly from Rhino using the Yak package manager:
Install directly from Rhino using the Yak package manager in command line:
```
_PackageManager
```
Or search for "Axys" in the Rhino package manager.

Then find the plugin:
```
Axys
```
And install the latest version.

Alternatively, you can download the package directly as a .zip from the assets below.
---
*This release was automatically built and published from tag `${{ env.TAG_NAME }}`*
files: |
Expand Down
19 changes: 11 additions & 8 deletions docfx_project/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,22 @@ git clone https://github.com/Apollo-ARTE/Axys-RhinoPlugin.git

## Publishing a New Version

To publish a new version of the plugin to the Yak server and create a GitHub release:
If you have o publish a new version of the plugin to the Yak server and create a GitHub release:

### 1. Tag the Release
### 1. Open a Pull Request to Main

After the commit, run the following commands, replacing `1.2.3` with the new version:
Once it’s merged and a version tag is pushed, the release process will run automatically.

### 2. Ask an Admin for Review to Release

For the changes to be released the admin needs to merge the pull request and push the release tag to main.

```bash
git tag v1.2.3
git push v1.2.3
git checkout main
git pull origin main
git tag v1.1.0
git push origin v1.1.0
```
### 2. Open a Pull Request to main branch

Once it’s merged and a version tag is pushed, the release process will run automatically.

---

Expand Down