feat: Add deployment with Portainer #74
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akandic47
requested review from
MakMuftic,
mpetrun5,
mpetrunic,
nmlinaric and
tcar121293
as code owners
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
23
to
99
| if: ${{ github.event.workflow_run.conclusion == 'success' || github.event.inputs.image_version }} | ||
| runs-on: | ||
| group: portainer-deployment | ||
| # environment: staging | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| clean: true | ||
|
|
||
| - name: Check if stack exists in Portainer | ||
| id: check_stack | ||
| env: | ||
| PORTAINER_URL: ${{ secrets.PORTAINER_URL }} | ||
| PORTAINER_API_TOKEN: ${{ secrets.PORTAINER_API_TOKEN }} | ||
| run: | | ||
| RESPONSE=$(curl -s -H "X-API-Key: ${{ secrets.PORTAINER_API_TOKEN }}" "${{ secrets.PORTAINER_URL }}/api/stacks") | ||
| STACK_ID=$(echo "$RESPONSE" | jq -r --arg name "$STACK_NAME" '.[] | select(.Name == $name) | .Id') | ||
|
|
||
| if [ -n "$STACK_ID" ]; then | ||
| echo "Stack exists. ID: $STACK_ID" | ||
| echo "exists=true" >> $GITHUB_OUTPUT | ||
| echo "stack_id=$STACK_ID" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "Stack does not exist." | ||
| echo "exists=false" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Render docker-compose.yml with envsubst | ||
| env: | ||
| DOCKER_COMPOSE_PATH: ./deploy/docker-compose.staging.yml | ||
| # export here all secrets used in the docker-compose environment | ||
| SIGNING_IMAGE_VERSION: ${{ github.event.inputs.image_version || 'latest' }} | ||
| CONFIG_1_FULL: ${{ secrets.CONFIG_1_FULL }} | ||
| CONFIG_2_FULL: ${{ secrets.CONFIG_2_FULL }} | ||
| CONFIG_3_FULL: ${{ secrets.CONFIG_3_FULL }} | ||
| KEYSHARE_1: ${{ secrets.KEYSHARE_1 }} | ||
| KEYSHARE_2: ${{ secrets.KEYSHARE_2}} | ||
| KEYSHARE_3: ${{ secrets.KEYSHARE_3 }} | ||
| run: | | ||
| envsubst < ${DOCKER_COMPOSE_PATH} > docker-compose.rendered.yml | ||
| echo "Rendered docker-compose" | ||
|
|
||
| - name: Deploy stack (create or update) | ||
| env: | ||
| PORTAINER_URL: ${{ secrets.PORTAINER_URL }} | ||
| PORTAINER_API_TOKEN: ${{ secrets.PORTAINER_API_TOKEN }} | ||
| run: | | ||
| ESCAPED_COMPOSE=$(cat docker-compose.rendered.yml | jq -Rs .) | ||
| STACK_EXISTS="${{ steps.check_stack.outputs.exists }}" | ||
| STACK_ID="${{ steps.check_stack.outputs.stack_id }}" | ||
|
|
||
| if [ "$STACK_EXISTS" = "true" ]; then | ||
| echo "Updating existing stack with ID: $STACK_ID" | ||
|
|
||
| echo "{\"stackFileContent\": $ESCAPED_COMPOSE, \"prune\": true, \"pullImage\": true, \"env\": []}" > payload.json | ||
|
|
||
| curl -s -X PUT "$PORTAINER_URL/api/stacks/$STACK_ID?endpointId=$PORTAINER_ENDPOINT_ID" \ | ||
| -H "X-API-Key: $PORTAINER_API_TOKEN" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d @payload.json \ | ||
| --fail | ||
| else | ||
| echo "Creating new stack: $STACK_NAME" | ||
|
|
||
| echo "{\"name\": \"$STACK_NAME\", \"fromAppTemplate\": false, \"stackFileContent\": $ESCAPED_COMPOSE, \"env\": []}" > payload.json | ||
| cat payload.json | ||
| curl -v -s -X POST "$PORTAINER_URL/api/stacks/create/standalone/string?endpointId=$PORTAINER_ENDPOINT_ID" \ | ||
| -H "X-API-Key: $PORTAINER_API_TOKEN" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d @payload.json \ | ||
| --fail | ||
| fi | ||
|
|
||
| - name: Cleanup | ||
| run: rm -rf docker-compose.rendered.yml payload.json |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 3 months ago
To fix the issue, explicitly add a permissions block with the minimal privilege required to the workflow file. You can place this block at the top of the workflow YAML (after name: and before on:) to apply the permission settings globally for all jobs within the workflow, or inside individual jobs if different jobs require distinct permissions. In this case, the workflow does not need to write to contents, issues, or pull requests—so contents: read is the correct, minimal starting setting. Add the permissions: stanza after line 1 and before the on: block (current line 5). No imports or other definition changes are necessary; simply the addition of a YAML block at the right place.
Suggested changeset
1
.github/workflows/deploy-portainer-staging.yml
| @@ -1,5 +1,8 @@ | ||
| name: Deploy to staging | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| run-name: Deploy Sprinter signing with Portainer to staging - ${{ github.event.inputs.image_version || 'latest' }} by @${{ github.actor }} | ||
|
|
||
| on: |
Copilot is powered by AI and may make mistakes. Always verify output.
|
Go Test coverage is 54.9 %\ ✨ ✨ ✨ |
|
Go Test coverage is 54.9 %\ ✨ ✨ ✨ |
|
Go Test coverage is 54.9 %\ ✨ ✨ ✨ |
akandic47
changed the title
|
Go Test coverage is 54.9 %\ ✨ ✨ ✨ |
mpetrun5
previously approved these changes
Oct 9, 2025
mpetrun5
approved these changes
Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related Issue Or Context
Closes: #
How Has This Been Tested? Testing details.
Types of changes
Checklist: