Merge pull request #177 from Dasharo/develop

Release v2.0.0
Dasharo · Oct 2, 2024 · f58330b · f58330b
2 parents 64992b4 + e1fe43b
commit f58330b
Show file tree

Hide file tree

Showing 100 changed files with 1,257 additions and 5,330 deletions.
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,3 @@
+[codespell]
+exclude-file = .codespellx
+ignore-words-list = crate, hsi
diff --git a/.codespellx b/.codespellx
diff --git a/.conform.yaml b/.conform.yaml
@@ -0,0 +1,16 @@
+---
+policies:
+  - type: commit
+    spec:
+      header:
+        length: 80
+        imperative: false
+        invalidLastCharacters: .
+      body:
+        required: false
+      dco: true
+      gpg:
+        required: true
+      spellcheck:
+        locale: US
+      maximumOfOneCommit: false
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,5 @@
-name: CI on push tag
+---
+name: CI on push release tag
 on:
   push:
     tags:
@@ -40,7 +41,7 @@ jobs:
             echo "At least one build attempt succeeded."
           fi
   deploy-images:
-    name: Deploy DTS artifacts on boot.dasharo.com
+    name: Deploy DTS artifacts on boot.dasharo.com and GitHub Release
     if: ${{ always() && contains(join(needs.*.result, ','), 'success') }}
     needs: build
     runs-on:
@@ -50,18 +51,17 @@ jobs:
         shell: bash
         env:
           SSH_KEY: ${{secrets.SSH_KEY}}
-          SSH_KEY_GITEA: ${{secrets.SSH_KEY_GITEA}}
+          SSH_KEY_CI_CD: ${{secrets.SSH_KEY_CI_CD}}
         run: |
           echo -e ${SSH_KEY} > ~/.ssh/dts-ci-key
           chmod 600 ~/.ssh/dts-ci-key
-          echo -e ${SSH_KEY_GITEA} > ~/.ssh/gitea-key
-          chmod 600 ~/.ssh/gitea-key
-          cp ~/.ssh/config ~/.ssh/config-old
+          echo -e ${SSH_KEY_CI_CD} > ~/.ssh/gitea_dts_release_cicd
+          chmod 600 ~/.ssh/gitea_dts_release_cicd
           echo -e "\n
           Host git.3mdeb.com\n
           HostName       git.3mdeb.com\n
-          IdentityFile   ~/.ssh/gitea-key\n
-          IdentitiesOnly yes" >> ~/.ssh/config
+          IdentityFile   ~/.ssh/gitea_dts_release_cicd\n
+          IdentitiesOnly yes" > ~/.ssh/config_deploy
       - name: Get DTS version
         id: dts-ver
         shell: bash
@@ -126,18 +126,18 @@ jobs:
         run: |
           ./meta-dts/scripts/generate-ipxe-menu.sh ${{ env.DTS_VER }}
           scp -i ~/.ssh/dts-ci-key dts.ipxe builder@10.1.40.2:boot/dts/
-      - name: Trigger signing
+      - name: Trigger signing and deploy to GitHub Release tab
         shell: bash
         run: |
           DTS_VER="${{ env.DTS_VER }}"
-          git clone ssh://git@git.3mdeb.com:2222/3mdeb/dts-release-cicd-pipeline.git
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git clone ssh://git@git.3mdeb.com:2222/3mdeb/dts-release-cicd-pipeline.git
           cd dts-release-cicd-pipeline
           echo ${DTS_VER} > LATEST_RELEASE
           git add LATEST_RELEASE
           git commit -m "Signing release ${DTS_VER}"
-          git push origin main
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git push origin main
           git tag ${DTS_VER}
-          git push origin ${DTS_VER}
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git push origin ${DTS_VER}
           cd -
   cleanup:
     name: Cleanup
@@ -151,7 +151,5 @@ jobs:
         run: |
           rm -rf ~/.ssh/dts-ci-key
           rm -rf dts-release-cicd-pipeline
-          rm -f ~/.ssh/gitea-key
+          rm -f ~/.ssh/gitea_dts_release_cicd
           rm -rf build
-          rm -f ~/.ssh/config
-          mv ~/.ssh/config-old ~/.ssh/config
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -1,4 +1,5 @@
-name: CI on push to develop
+---
+name: CI on push develop tag
 on:
   push:
     tags:
@@ -39,7 +40,7 @@ jobs:
             echo "At least one build attempt succeeded."
           fi
   deploy-images:
-    name: Deploy DTS artifacts on GitHub Releases tab
+    name: Deploy DTS artifacts on boot.dasharo.com
     if: ${{ always() && contains(join(needs.*.result, ','), 'success') }}
     needs: build
     runs-on:
@@ -49,18 +50,17 @@ jobs:
         shell: bash
         env:
           SSH_KEY: ${{secrets.SSH_KEY}}
-          SSH_KEY_GITEA: ${{secrets.SSH_KEY_GITEA}}
+          SSH_KEY_CI_CD: ${{secrets.SSH_KEY_CI_CD}}
         run: |
           echo -e ${SSH_KEY} > ~/.ssh/dts-ci-key
           chmod 600 ~/.ssh/dts-ci-key
-          echo -e ${SSH_KEY_GITEA} > ~/.ssh/gitea-key
-          chmod 600 ~/.ssh/gitea-key
-          cp ~/.ssh/config ~/.ssh/config-old
+          echo -e ${SSH_KEY_CI_CD} > ~/.ssh/gitea_dts_release_cicd
+          chmod 600 ~/.ssh/gitea_dts_release_cicd
           echo -e "\n
           Host git.3mdeb.com\n
           HostName       git.3mdeb.com\n
-          IdentityFile   ~/.ssh/gitea-key\n
-          IdentitiesOnly yes" >> ~/.ssh/config
+          IdentityFile   ~/.ssh/gitea_dts_release_cicd\n
+          IdentitiesOnly yes" > ~/.ssh/config_deploy
       - name: Get DTS version
         id: dts-ver
         shell: bash
@@ -121,14 +121,14 @@ jobs:
         shell: bash
         run: |
           DTS_VER="${{ env.DTS_VER }}"
-          git clone ssh://git@git.3mdeb.com:2222/3mdeb/dts-release-cicd-pipeline.git
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git clone ssh://git@git.3mdeb.com:2222/3mdeb/dts-release-cicd-pipeline.git
           cd dts-release-cicd-pipeline
           echo ${DTS_VER} > LATEST_RELEASE
           git add LATEST_RELEASE
           git commit -m "Signing release ${DTS_VER}"
-          git push origin main
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git push origin main
           git tag ${DTS_VER}
-          git push origin ${DTS_VER}
+          GIT_SSH_COMMAND='ssh -F ~/.ssh/config_deploy' git push origin ${DTS_VER}
           cd -
   cleanup:
     name: Cleanup
@@ -142,7 +142,5 @@ jobs:
         run: |
           rm -rf ~/.ssh/dts-ci-key
           rm -rf dts-release-cicd-pipeline
-          rm -f ~/.ssh/gitea-key
+          rm -f ~/.ssh/gitea_dts_release_cicd
           rm -rf build
-          rm -f ~/.ssh/config
-          mv ~/.ssh/config-old ~/.ssh/config
diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml
@@ -1,3 +1,4 @@
+---
 name: Weekly clean & rebuild
 on:
   schedule:

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,196 @@
+---
+# Documentation:
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+
+# Default state for all rules
+default: false
+
+# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: true
+
+# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
+MD002:
+  # Heading level
+  level: 1
+
+# MD003/heading-style/header-style - Heading style
+
+MD003:
+  # Heading style
+  # # ATX style H1
+  style: "atx"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  # List style
+  style: "sublist"
+
+# MD005/list-indent - Inconsistent indentation for list items at the same level
+MD005: true
+
+# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
+MD006: true
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4
+  # Whether to indent the first level of the list
+  start_indented: false
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+MD010:
+  # Include code blocks
+  code_blocks: false
+  # Number of spaces for each hard tab
+  spaces_per_tab: 1
+
+# MD011/no-reversed-links - Reversed link syntax
+MD011: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+# MD013/line-length - Line length
+#
+MD013:
+  # Number of characters
+  line_length: 80
+  # Number of characters for headings
+  heading_line_length: 80
+  # Number of characters for code blocks
+  code_block_line_length: 160
+  # Include code blocks
+  code_blocks: false
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Strict length checking (e.g. allow for longer URLs)
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD014/commands-show-output - Dollar signs used before commands without showing output
+# TODO: set false for now but we should consider enabling it
+# https://cirosantilli.com/markdown-style-guide#dollar-signs-in-shell-code
+MD014: false
+
+# MD018/no-missing-space-atx - No space after hash on atx style heading
+MD018: true
+
+# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
+MD019: true
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
+MD023: true
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+# TODO: consider enabling it
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
+MD027: true
+
+# MD028/no-blanks-blockquote - Blank line inside blockquote
+MD028: true
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
+MD031:
+  # Include list items
+  list_items: true
+
+# MD033/no-inline-html - Inline HTML
+MD033:
+  # Allowed elements
+  allowed_elements: ["br", "center", "img", "script", "form", "input"]
+
+# MD034/no-bare-urls - Bare URL used
+MD034: true
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "---"
+
+# MD037/no-space-in-emphasis - Spaces inside emphasis markers
+MD037: true
+
+# MD038/no-space-in-code - Spaces inside code span elements
+MD038: true
+
+# MD039/no-space-in-links - Spaces inside link text
+MD039: true
+
+# MD040/fenced-code-language - Fenced code blocks should have a language specified
+MD040: true
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD042/no-empty-links - No empty links
+MD042: true
+
+# MD046/code-block-style - Code block style
+MD046:
+  # Block style
+  style: "fenced"
+
+# MD047/single-trailing-newline - Files should end with a single newline character
+MD047: true
+
+# MD048/code-fence-style - Code fence style
+MD048:
+  # Code fence style
+  style: "backtick"
+
+# MD049/emphasis-style - Emphasis style should be consistent
+MD049:
+  # Emphasis style should be consistent
+  style: "underscore"
+
+# MD050/strong-style - Strong style should be consistent
+MD050:
+  # Strong style should be consistent
+  style: "asterisk"