From c59bedbf12745c61cb660afce682b5c16b5fa073 Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 22 May 2024 12:58:12 +0100 Subject: [PATCH] adrs --- docs/about.markdown | 18 ------- ...on_to_check_the_editorconfig_compliance.md | 40 ++++++++------- ...2_Scan_repository_for_hardcoded_secrets.md | 32 +++++++----- ...GitHub_PAT_and_Apps_for_authN_and_authZ.md | 50 +++++++++++-------- docs/adrs.md | 6 +++ 5 files changed, 76 insertions(+), 70 deletions(-) delete mode 100644 docs/about.markdown create mode 100644 docs/adrs.md diff --git a/docs/about.markdown b/docs/about.markdown deleted file mode 100644 index 8b4e0b2..0000000 --- a/docs/about.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: About -permalink: /about/ ---- - -This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) - -You can find the source code for Minima at GitHub: -[jekyll][jekyll-organization] / -[minima](https://github.com/jekyll/minima) - -You can find the source code for Jekyll at GitHub: -[jekyll][jekyll-organization] / -[jekyll](https://github.com/jekyll/jekyll) - - -[jekyll-organization]: https://github.com/jekyll diff --git a/docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md b/docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md index 0ddc032..ba27233 100644 --- a/docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md +++ b/docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md @@ -1,4 +1,10 @@ -# ADR-001: Use git hook and GitHub Action to check the `.editorconfig` compliance +--- +layout: default +title: ADR-001 +parent: ADRs +--- + +## ADR-001: Use git hook and GitHub Action to check the `.editorconfig` compliance >| | | >| ------------ | ---------------------------------------------------- | @@ -11,22 +17,22 @@ --- - [ADR-001: Use git hook and GitHub Action to check the `.editorconfig` compliance](#adr-001-use-git-hook-and-github-action-to-check-the-editorconfig-compliance) - - [Context](#context) - - [Decision](#decision) - - [Assumptions](#assumptions) - - [Drivers](#drivers) - - [Options](#options) - - [Options 1: The pre-commit project](#options-1-the-pre-commit-project) - - [Options 2a: Custom shell script](#options-2a-custom-shell-script) - - [Options 2b: Docker-based custom shell script](#options-2b-docker-based-custom-shell-script) - - [Option 3: A GitHub Action from the Marketplace](#option-3-a-github-action-from-the-marketplace) - - [Outcome](#outcome) - - [Rationale](#rationale) - - [Consequences](#consequences) - - [Compliance](#compliance) - - [Notes](#notes) - - [Actions](#actions) - - [Tags](#tags) +- [Context](#context) +- [Decision](#decision) + - [Assumptions](#assumptions) + - [Drivers](#drivers) + - [Options](#options) + - [Options 1: The pre-commit project](#options-1-the-pre-commit-project) + - [Options 2a: Custom shell script](#options-2a-custom-shell-script) + - [Options 2b: Docker-based custom shell script](#options-2b-docker-based-custom-shell-script) + - [Option 3: A GitHub Action from the Marketplace](#option-3-a-github-action-from-the-marketplace) + - [Outcome](#outcome) + - [Rationale](#rationale) +- [Consequences](#consequences) +- [Compliance](#compliance) +- [Notes](#notes) +- [Actions](#actions) +- [Tags](#tags) ## Context diff --git a/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md b/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md index 0cf78d4..05423df 100644 --- a/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md +++ b/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md @@ -1,4 +1,10 @@ -# ADR-002: Scan repository for hard-coded secrets +--- +layout: default +title: ADR-002 +parent: ADRs +--- + +## ADR-002: Scan repository for hard-coded secrets >| | | >| ------------ | ------------------------------------------------------------- | @@ -11,18 +17,18 @@ --- - [ADR-002: Scan repository for hard-coded secrets](#adr-002-scan-repository-for-hard-coded-secrets) - - [Context](#context) - - [Decision](#decision) - - [Assumptions](#assumptions) - - [Drivers](#drivers) - - [Options](#options) - - [Outcome](#outcome) - - [Rationale](#rationale) - - [Consequences](#consequences) - - [Compliance](#compliance) - - [Notes](#notes) - - [Actions](#actions) - - [Tags](#tags) +- [Context](#context) +- [Decision](#decision) + - [Assumptions](#assumptions) + - [Drivers](#drivers) + - [Options](#options) + - [Outcome](#outcome) + - [Rationale](#rationale) +- [Consequences](#consequences) +- [Compliance](#compliance) +- [Notes](#notes) +- [Actions](#actions) +- [Tags](#tags) ## Context diff --git a/docs/adr/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md b/docs/adr/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md index cd82a32..846c134 100644 --- a/docs/adr/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md +++ b/docs/adr/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md @@ -1,4 +1,10 @@ -# ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms +--- +layout: default +title: ADR-003 +parent: ADRs +--- + +## ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms >| | | >| ------------ | --- | @@ -11,27 +17,27 @@ --- - [ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms](#adr-003-acceptable-use-of-github-authentication-and-authorisation-mechanisms) - - [Context](#context) - - [Decision](#decision) - - [Assumptions](#assumptions) - - [Drivers](#drivers) - - [Options](#options) - - [Outcome](#outcome) - - [Built-in authentication using `GITHUB_TOKEN` secret](#built-in-authentication-using-github_token-secret) - - [GitHub PAT (fine-grained Personal Access Token)](#github-pat-fine-grained-personal-access-token) - - [GitHub App](#github-app) - - [Rationale](#rationale) - - [Notes](#notes) - - [GitHub App setup](#github-app-setup) - - [Recommendation for GitHub Admins](#recommendation-for-github-admins) - - [Diagram](#diagram) - - [Context diagram showing the GitHub App setup](#context-diagram-showing-the-github-app-setup) - - [Authentication flow diagram](#authentication-flow-diagram) - - [Limitations](#limitations) - - [Examples of acquiring access token](#examples-of-acquiring-access-token) - - [Actions](#actions) - - [Tags](#tags) - - [Footnotes](#footnotes) +- [Context](#context) +- [Decision](#decision) + - [Assumptions](#assumptions) + - [Drivers](#drivers) + - [Options](#options) + - [Outcome](#outcome) + - [Built-in authentication using `GITHUB_TOKEN` secret](#built-in-authentication-using-github_token-secret) + - [GitHub PAT (fine-grained Personal Access Token)](#github-pat-fine-grained-personal-access-token) + - [GitHub App](#github-app) + - [Rationale](#rationale) +- [Notes](#notes) + - [GitHub App setup](#github-app-setup) + - [Recommendation for GitHub Admins](#recommendation-for-github-admins) + - [Diagram](#diagram) + - [Context diagram showing the GitHub App setup](#context-diagram-showing-the-github-app-setup) + - [Authentication flow diagram](#authentication-flow-diagram) + - [Limitations](#limitations) + - [Examples of acquiring access token](#examples-of-acquiring-access-token) +- [Actions](#actions) +- [Tags](#tags) +- [Footnotes](#footnotes) ## Context diff --git a/docs/adrs.md b/docs/adrs.md new file mode 100644 index 0000000..49c64e8 --- /dev/null +++ b/docs/adrs.md @@ -0,0 +1,6 @@ +--- +layout: default +title: ADRs +nav_order: 2 +has_children: true +---