search

DFE-Digital / technical-guidance

Principles, standards and guidance for digital delivery teams
https://technical-guidance.education.gov.uk/
Other
22 stars 18 forks source link

Review and update page: "Storing Source Code" #165

Open RogerHowellDfE opened 1 year ago

RogerHowellDfE commented 1 year ago

I keep flip-flopping on whether this goes beyond the scope of a "review".

Much of it is needed additional information/context/cross-linking, I'm just not sure if it belongs in this specific PR on this specific file vs being done in a separate follow up PR...

Thoughts / comments / feedback (positive or otherwise) strongly encouraged and welcomed!

RogerHowellDfE commented 1 year ago

Checks (deployment to temporary instance) are failing due to this PR being sourced from a fork, therefore relevant secrets are (rightly) being withheld from the GItHub Action run.

I don't yet have permissions to create / push to a branch on the repo directly.

RogerHowellDfE commented 1 year ago

Should/could also include a mention of maintaining the integrity of the repo also: e.g., branch protection rules

Potential opportunity to also include build/test checks on pull requests and mention the option to specify "required statuses" -- this helps to protect and maintain the integrity of the source code we're storing

... as do other automated scanning tools and update management -- but I fear this is where we definitely creep across the line from being able to include it on a page titled "storing source code" and into "should be on a separate page 😀" (perhaps a page on CI and/or CD?)

pritchyspritch commented 1 month ago

@RogerHowellDfE @peteryates Any particular reason this never got merged? I was planning on producing some good github standards and guidance, this seems like a good start.

saliceti commented 1 month ago

@RogerHowellDfE the test pipeline doesn't work as the PR was opened outside of this repo. You have write access, do you mind reopening it from this repo?