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.

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

Add installer to release asset issue - #139 #149

Merged
merged 10 commits into from
Mar 7, 2025
+32 −5
Merged

Add installer to release asset issue - #139 #149

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
33aa04c
Added installer as a release asset #139
Mar 4, 2025
dc3d146
docker files updated
Mar 4, 2025
7771337
add installer to release docker files updated
Mar 4, 2025
76b5d2d
add installer to release docker files updation
Mar 4, 2025
f3cd0d8
updated files for adding installer to release
Mar 6, 2025
a6d8ba7
version updated
Mar 6, 2025
3659310
Merge branch 'main' into add-installer-to-release
Srajald Mar 6, 2025
768d258
Update settings.json
Srajald Mar 6, 2025
e8c14e7
Updated the release
Srajald Mar 6, 2025
c03f4e6
Merge remote-tracking branch 'origin/main' into pr-149
t0mdavid-m Mar 7, 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
8 changes: 8 additions & 0 deletions .github/workflows/build-windows-executable-app-with-pyinstaller.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,3 +270,11 @@ jobs:
with:
name: OpenMS-App
path: dist

- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
uses: softprops/action-gh-release@v1
with:
files: OpenMS-App.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Update the Release Asset Upload Step for Compatibility and Formatting

  • The new "Upload Artifact as Release Asset" step uses softprops/action-gh-release@v1, which is flagged by static analysis as outdated. Consider updating it to a newer version (for example, softprops/action-gh-release@v2) to ensure compatibility with current GitHub Actions runners.
  • Additionally, remove any trailing spaces (noted at line 273) and ensure the file ends with a newline (as flagged at line 280).
-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@v2
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
uses: softprops/action-gh-release@v1
with:
files: OpenMS-App.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
uses: softprops/action-gh-release@v2
with:
files: OpenMS-App.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
🧰 Tools
🪛 actionlint (1.7.4)

276-276: the runner of "softprops/action-gh-release@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🪛 YAMLlint (1.35.1)

[error] 273-273: trailing spaces

(trailing-spaces)

[error] 280-280: no new line character at the end of file

(new-line-at-end-of-file)

18 changes: 18 additions & 0 deletions .github/workflows/build-windows-executable-app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
release:
types: [created]
workflow_dispatch:

env:
Expand Down Expand Up @@ -175,6 +177,14 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Set Version in settings.json
run: |
$VERSION="${{ github.event.release.tag_name }}"
$content = Get-Content -Raw settings.json | ConvertFrom-Json
$content.version = $VERSION
$content | ConvertTo-Json -Depth 100 | Set-Content settings.json


- name: Download package as artifact
uses: actions/download-artifact@v4
with:
Expand Down Expand Up @@ -408,3 +418,11 @@ jobs:
name: OpenMS-App
path: |
OpenMS-App.zip

- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
uses: softprops/action-gh-release@v1
with:
files: OpenMS-App.zip
env:
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Update the Release Asset Upload Step for Consistency
Similar to the PyInstaller workflow, the "Upload Artifact as Release Asset" step here also uses softprops/action-gh-release@v1. Update this to a newer version (e.g., softprops/action-gh-release@v2) to avoid potential runtime issues, as noted by static analysis.

-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@v2
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
uses: softprops/action-gh-release@v1
with:
files: OpenMS-App.zip
env:
- name: Upload Artifact as Release Asset
if: github.event_name == 'release'
- uses: softprops/action-gh-release@v1
+ uses: softprops/action-gh-release@v2
with:
files: OpenMS-App.zip
env:
🧰 Tools
🪛 actionlint (1.7.4)

424-424: the runner of "softprops/action-gh-release@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5 changes: 3 additions & 2 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,15 @@ RUN mamba run -n streamlit-env python hooks/hook-analytics.py
# Set Online Deployment
RUN jq '.online_deployment = true' settings.json > tmp.json && mv tmp.json settings.json

# Download latest OpenMS App executable for Windows from Github actions workflow.
# Download latest OpenMS App executable as a ZIP file
RUN if [ -n "$GH_TOKEN" ]; then \
echo "GH_TOKEN is set, proceeding to download the release asset..."; \
gh run download -R ${GITHUB_USER}/${GITHUB_REPO} $(gh run list -R ${GITHUB_USER}/${GITHUB_REPO} -b main -e push -s completed -w "Build executable for Windows" --json databaseId -q '.[0].databaseId') -n OpenMS-App --dir /app; \
gh release download -R ${GITHUB_USER}/${GITHUB_REPO} -p "OpenMS-App.zip" -D /app; \
else \
echo "GH_TOKEN is not set, skipping the release asset download."; \
fi


# Run app as container entrypoint.
EXPOSE $PORT
ENTRYPOINT ["/app/entrypoint.sh"]
4 changes: 2 additions & 2 deletions Dockerfile_simple
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ RUN mamba run -n streamlit-env python hooks/hook-analytics.py
# Set Online Deployment
RUN jq '.online_deployment = true' settings.json > tmp.json && mv tmp.json settings.json

# Download latest OpenMS App executable for Windows from Github actions workflow.
# Download latest OpenMS App executable as a ZIP file
RUN if [ -n "$GH_TOKEN" ]; then \
echo "GH_TOKEN is set, proceeding to download the release asset..."; \
gh run download -R ${GITHUB_USER}/${GITHUB_REPO} $(gh run list -R ${GITHUB_USER}/${GITHUB_REPO} -b main -e push -s completed -w "Build executable for Windows" --json databaseId -q '.[0].databaseId') -n OpenMS-App --dir /app; \
gh release download -R ${GITHUB_USER}/${GITHUB_REPO} -p "OpenMS-App.zip" -D /app; \
else \
echo "GH_TOKEN is not set, skipping the release asset download."; \
fi
Expand Down
3 changes: 2 additions & 1 deletion settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
"tag": "57690c44-d635-43b0-ab43-f8bd3064ca06"
}
},
"online_deployment": false
"online_deployment": false,
"version": "0.0.0"
}