chore: rework action readme

LedgerHQ · Sep 13, 2024 · 0a438d0 · 0a438d0
1 parent a0a4869
commit 0a438d0
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/actions/attest/README.md b/actions/attest/README.md
@@ -1,4 +1,4 @@
-# Action: attest
+# GitHub Action: `attest`
 
 <!-- action-docs-description source="action.yml" -->
 ## Description
@@ -9,13 +9,19 @@ This action is used to generate a provenance file and to sign it (attestation in
 ## Usage
 
 ### Permissions
+
+To enable this action to work properly, ensure the following permissions are set in your workflow:
+
 ```yaml
 permissions:
     id-token: write
     attestations: write
 ```
 
 ### Example Workflow
+
+Here's how you can use the `attest` action within your workflow:
+
 ```yaml
 jobs:
   release:
@@ -44,8 +50,6 @@ jobs:
 <!-- action-docs-outputs source="action.yml" -->
 
 
-<!-- action-docs-runs source="action.yml" -->
 ## Runs
 
-This action is a `composite` action.
-<!-- action-docs-runs source="action.yml" -->
+This action is a **composite action**, which allows us to combine multiple workflow steps into a single, reusable action. This promotes modularity and simplifies our workflows.
diff --git a/actions/sign-blob/README.md b/actions/sign-blob/README.md
@@ -1,4 +1,4 @@
-# Action: sign-blob
+# GitHub Action: `sign-blob`
 
 <!-- action-docs-description source="action.yml" -->
 ## Description
@@ -9,12 +9,18 @@ This action is used to sign blobs in keyless mode based on Github OIDC token.
 ## Usage
 
 ### Permissions
+
+To enable this action to work properly, ensure the following permissions are set in your workflow:
+
 ```yaml
 permissions:
     id-token: write
 ```
 
 ### Example Workflow
+
+Here's how you can use the `sign-blob` action within your workflow:
+
 ```yaml
 jobs:
   release:
@@ -40,8 +46,6 @@ jobs:
 <!-- action-docs-outputs source="action.yml" -->
 
 
-<!-- action-docs-runs source="action.yml" -->
 ## Runs
 
-This action is a `composite` action.
-<!-- action-docs-runs source="action.yml" -->
+This action is a **composite action**, which allows us to combine multiple workflow steps into a single, reusable action. This promotes modularity and simplifies our workflows.
diff --git a/actions/sign-container/README.md b/actions/sign-container/README.md
@@ -1,4 +1,4 @@
-# Action: sign-blob
+# GitHub Action: `sign-container`
 
 <!-- action-docs-description source="action.yml" -->
 ## Description
@@ -9,12 +9,18 @@ This action is used to sign a container image with a list of tags in keyless mod
 ## Usage
 
 ### Permissions
+
+To enable this action to work properly, ensure the following permissions are set in your workflow:
+
 ```yaml
 permissions:
     id-token: write
 ```
 
 ### Example Workflow
+
+Here's how you can use the `sign-container` action within your workflow:
+
 ```yaml
 jobs:
   release:
@@ -42,8 +48,6 @@ jobs:
 <!-- action-docs-outputs source="action.yml" -->
 
 
-<!-- action-docs-runs source="action.yml" -->
 ## Runs
 
-This action is a `composite` action.
-<!-- action-docs-runs source="action.yml" -->
+This action is a **composite action**, which allows us to combine multiple workflow steps into a single, reusable action. This promotes modularity and simplifies our workflows.