ministryofjustice / hmpps-architecture-as-code

Modelling the software architecture of HMPPS Digital
https://structurizr.com/share/56937
Other
17 stars 3 forks source link

Enforce code style #11

Closed sldblog closed 4 years ago

sldblog commented 4 years ago

Everyone has different editors

Let's enforce a consistent style, so we don't auto-format over each other

spikeheap commented 4 years ago

:+1: I completely agree. Would EditorConfig get us where we want to be? If so, I'll add a Readme entry for it...

spikeheap commented 4 years ago

So... we have EditorConfig to promote consistency, but #28 (to enforce it) highlighted a bug in the GitHub Action available on the marketplace.

We could

  1. Fork that and publish a new version to get us moving
  2. Write our own job to install/run EditorConfig
  3. Wait for a fix on that action
  4. Add a readme telling contributors to use EditorConfig, and say that level of promotion is enough for now

I think I favour option 4, purely because it's the least effort, but I'm not particularly tied to anything 😀

sldblog commented 4 years ago

Looking at the workflow syntax it looks like it's possible to use an action repository's commit SHA instead of a tag. I'll try it on the closed PR

sldblog commented 4 years ago

It worked 🎉 https://github.com/ministryofjustice/hmpps-architecture-as-code/runs/858135711

sldblog commented 4 years ago

Closed by #28 (and enforced by requiring that CI build to pass).