From cdde2224615450f849142f27de3acd3d6707b523 Mon Sep 17 00:00:00 2001 From: Ilia Sedelkin Date: Mon, 23 Jun 2025 15:09:29 +0200 Subject: [PATCH 1/2] Update documentation with release instructions --- .github/workflows/yak-release.yml | 11 ++++++++--- docfx_project/index.md | 19 +++++++++++-------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/.github/workflows/yak-release.yml b/.github/workflows/yak-release.yml index 34b997a..a14189b 100644 --- a/.github/workflows/yak-release.yml +++ b/.github/workflows/yak-release.yml @@ -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: | diff --git a/docfx_project/index.md b/docfx_project/index.md index c6e4811..a5b7638 100644 --- a/docfx_project/index.md +++ b/docfx_project/index.md @@ -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. --- From ae2105921a5b0e816f49479978fb893b5d2b4c04 Mon Sep 17 00:00:00 2001 From: Ilia Sedelkin Date: Mon, 23 Jun 2025 15:11:11 +0200 Subject: [PATCH 2/2] Update documentation --- .github/workflows/yak-release.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/yak-release.yml b/.github/workflows/yak-release.yml index a14189b..db74416 100644 --- a/.github/workflows/yak-release.yml +++ b/.github/workflows/yak-release.yml @@ -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 }}