Skip to content

AWS full test workflow revision handling differs from nf-core standard #85

@edmundmiller

Description

@edmundmiller

Description

The AWS test workflow in this repository uses different revision handling compared to the standard nf-core pattern, which may cause issues with S3 bucket path conflicts or unexpected behavior.

Current State (pairgenomealign)

revision: ${{ github.sha }}
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/pairgenomealign/work-${{ github.sha }}
parameters: |
  {
    "outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/pairgenomealign/results-test-${{ github.sha }}"
  }

Expected State (nf-core standard from rnaseq)

steps:
  - name: Set revision variable
    id: revision
    run: |
      echo "revision=${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'release') && github.sha || 'dev' }}" >> "$GITHUB_OUTPUT"

  - name: Launch workflow via Seqera Platform
    with:
      revision: ${{ steps.revision.outputs.revision }}
      workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/pairgenomealign/work-${{ steps.revision.outputs.revision }}
      parameters: |
        {
          "outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/pairgenomealign/results-${{ steps.revision.outputs.revision }}"
        }

Impact

The current hardcoded github.sha approach:

  1. Doesn't follow the nf-core standard pattern used by other pipelines
  2. May cause S3 path conflicts when the same SHA is used across different trigger events
  3. Doesn't use the conventional 'dev' revision for non-release builds

Reference

Standard pattern implemented in: https://github.com/nf-core/rnaseq/blob/master/.github/workflows/awsfulltest.yml

Action Required

Update the workflow to use dynamic revision handling that sets revision to 'dev' for regular runs and github.sha only for workflow_dispatch and release events.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions