dfe-analytical-services / dfe-analytical-services/dfeshiny

Document conventions for reusable workflows

Open
#119 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
7
Forks
3
Avg merge
8h 54m
Merged PRs (30d)
2

Description

## Is your feature request related to a problem? Please describe.
We've started some conventions with our reusable workflows, e.g. `workflow_reusable.yml`, though it'd be nice to explicitly note this and tidy up how they appear on PRs.

## Describe the solution you'd like
A note in contributing.md on what we're doing here with reusable workflows generally and then details of any naming conventions to follow.

A standard practice for naming that makes use of the 3 tier job hierarchy we've created

E.g. instead of the lintr one here

Image

We could do something like `dfeshiny / reusable / lintr` (or the reverse, or something similar)

## Describe alternatives you've considered
None, I think we should document somewhere and make more use of the job naming though.

## Additional context
None.

Contributor guide

Open the contributing guide

Research direction

Start with contributing.md and the existing workflow_reusable.yml workflow, then inspect the lintr workflow naming shown in the issue. Document the current reusable-workflow conventions and specify the agreed three-tier job naming pattern; done means the guidance is recorded and the relevant workflow job names follow it.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.