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

Improvement/nsis on GitHub ci #8

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 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
68 changes: 68 additions & 0 deletions .github/workflows/nsis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: nsis

on:
workflow_run:
workflows: [ Build ]
types: [ completed ]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if I should limit this script running to Releases only.
Personally though, I would recommend having a separate Release workflow that executes after the build and nsis/etc workflows to retrieve artifacts from Release tagged builds and creates a proper release here on GitHub.
That way, we could refactor the online installers to always pull the latest release, or to pull specific releases if needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the idea of a proper release.

As to whether the script should be limited to releases only, the only reason I could think of for that is size. If one of the installers bundles too much together and pushes us towards some limit, then that could be bad. Otherwise, it'd be nice to click on a specific merge and be able to install it and test it quickly.

workflow_dispatch:

jobs:
config:
if: ${{ github.event.workflow_run.conclusion == 'success' }}
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.files.outputs.matrix }}
branch: ${{ steps.branch-ref.outputs.name }}
steps:
- uses: actions/checkout@master
with:
ref: ${{ github.event.workflow_run.head_branch }}

- name: Return Branch
id: branch-ref
run: echo "::set-output name=${{ github.event.workflow_run.head_branch }}"

- name: Get Script Files
id: list-files
uses: Rishabh510/Path-lister-action@master
with:
path: installers/
type: .nsi

- name: Return Script Files
id: files
run: echo "::set-output name=matrix::$(echo "${{ steps.list-files.outputs.paths }}" | sed 's/\//\\/g' | jq --raw-input --compact-output '[splits(" ") | select(length > 0)]')"

make-installer:
runs-on: windows-latest
needs: [ config ]
strategy:
fail-fast: false
matrix:
file: ${{ fromJson(needs.config.outputs.matrix) }}
steps:
- uses: actions/checkout@master
with:
ref: ${{ github.event.workflow_run.head_branch }}

- name: Download artifact
uses: dawidd6/action-download-artifact@v2
with:
workflow: ${{ github.event.workflow_run.workflow_id }}
workflow_conclusion: success
name: hobovr-build-windows-latest
path: ${{ github.workspace }}

- name: Create nsis installer
id: create-installer
shell: powershell
run: |
"$CONDA\bin\conda.bat execute ${{ matrix.file }}"
working-directory: ${{ github.workspace }}\installers\win

- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: "hobovr_setup.exe" # Get the Output Name
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This really needs to be a value extracted from the .nsi file in the future, especially if we have multiple outputs.
I'll add this to the TODO of #5

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, this is a pretty big change already that's been in the works for about a week, so I think moving extra work into todos for after merging is a good idea. I'm not really sure how hard extracting the exe name from the nsi file and putting it in the yml will be though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SimLeek I've got this issue about 90% solved using SED in a separate branch already.

Should I fold it into this PR?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, if it's 100% solved, sure. From experience though, that last 10% can take 50% of the time.

path: |
hobovr
24 changes: 18 additions & 6 deletions installers/win/hobovr_installer.nsi
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
# plugins required:
# Inetc: https://nsis.sourceforge.io/Inetc_plug-in
# Nsisunz: https://nsis.sourceforge.io/Nsisunz_plug-in
# ExecDos: https://nsis.sourceforge.io/ExecDos_plug-in
# Locate: https://nsis.sourceforge.io/Locate_plugin
# Download the zip files from each of those and copy the contents of the plugin.zip/Plugins directory to program files/NSIS/plugins
# conda execute
# env:
# - nsis 3.*
# - AccessControl
# - InetC
# - Nsisunz
# - ExecDos
# - Locate
# - Registry
# - nsDialogs
# - winmessages
# - MUI2
# - Logiclib
# - x64
# channels:
# - nsis
# run_with: makensis

!include nsDialogs.nsh
!include MUI2.nsh
!include "winmessages.nsh"
Expand Down