nf-core / nf-core/pairgenomealign
AWS full test workflow revision handling differs from nf-core standard
Nobody has claimed this yet.
- Dominant language
- Nextflow
- Stars
- 12
- Forks
- 5
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 6
Description
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:
- Doesn't follow the nf-core standard pattern used by other pipelines
- May cause S3 path conflicts when the same SHA is used across different trigger events
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the repository's AWS full test workflow with the referenced nf-core/rnaseq .github/workflows/awsfulltest.yml pattern. Update revision handling so regular runs use "dev" while workflow_dispatch and release use github.sha, and ensure the workdir and outdir paths use the selected revision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, github-actions
- Domain
- ci-cd, cloud
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100