docs: add release process section to README

[probelabs]

Problem / Task

Add a 'Release process' section to the top of the README.md file in the github-actions repository to document the release process using the floating @production tag.

Changes

• Created docs/release-process.md containing the release process documentation.
• Modified Taskfile.yml to include docs/release-process.md in the gen:readme task.
• Regenerated README.md by running task gen:readme.

Testing

• Verified that running task gen:readme successfully generates the README.md with the new 'Release process' section at the top.

[probelabs]

This pull request introduces documentation for the release process of the shared GitHub Actions within this repository.

Files Changed Analysis

• docs/release-process.md: A new file has been added to describe the release procedure, which relies on a floating @production tag.
• Taskfile.yml: The gen:readme task has been updated to incorporate the new release-process.md file into the main README.md.
• README.md: This file has been regenerated. The primary change is the addition of the new "Release process" section at the top. The regeneration also resulted in significant reformatting and cleanup of other sections, marking several existing actions as "Undocumented action" and removing their detailed usage examples.

Architecture & Impact Assessment

• Accomplishment: The PR documents the release process, clarifying for contributors how changes are promoted to production and consumed by other repositories.
• Key Technical Changes: The core change is the introduction of a new documentation source file (docs/release-process.md) and its integration into the existing documentation generation script (Taskfile.yml).
• Affected Components: This change affects the repository's developer-facing documentation and the process for maintaining it.

Release Flow

graph TD
    A[1. Contributor creates PR to main] --> B{2. Review & Merge};
    B --> C[Changes are on main branch];
    C --> D{3. Request tag move on Slack};
    D --> E["4. Repo owner moves @production tag"];
    E --> F[Changes are live for consumers];

Loading

Scope Discovery & Context Expansion

The scope of this PR is confined to documentation. The changes clarify the release workflow for developers contributing to this repository and for teams consuming these actions. The modifications to Taskfile.yml confirm that the README.md is an auto-generated artifact. The side-effect of cleaning up the README.md highlights that the source documentation for several other actions may be incomplete.

Metadata

• Review Effort: 1 / 5
• Primary Label: documentation

---

Powered by Visor from Probelabs

Last updated: 2026-06-01T11:30:38.190Z | Triggered by: pr_opened | Commit: 529bcce

💡 TIP: You can chat with Visor using /visor ask <your question>

[probelabs]

Security Issues (1)

Severity	Location	Issue
🟡 Warning	docs/release-process.md:3-5	The documented release process mandates the use of a floating tag (`@production`) for consuming GitHub Actions. This practice introduces a supply chain risk, as any new code pushed to the `main` branch and tagged as `@production` is automatically adopted by all consumers. If a malicious or faulty commit is merged, it will be immediately propagated across all workflows, potentially causing widespread disruption or security breaches. Pinning to a floating tag sacrifices the immutability and verifiability of dependencies. 💡 Suggestion For enhanced security and stability, consumers should pin actions to specific, immutable Git commit SHAs (e.g., `TykTechnologies/github-actions@<commit-sha>`). This ensures that workflows use a specific, vetted version of the action. If using tags is preferred, use versioned, immutable tags (e.g., `@v1.2.3`) instead of a floating tag. The release process should be updated to create versioned tags upon release, rather than moving a floating tag.

✅ Performance Check Passed

No performance issues found – changes LGTM.

Quality Issues (1)

Severity	Location	Issue
🟠 Error	README.md:264-305	The regeneration of `README.md` has removed detailed documentation and usage examples for several workflows, such as 'Release bot' and 'SentinelOne CNS Scans', replacing them with 'Undocumented action'. This is a documentation regression that makes the workflows harder to use. 💡 Suggestion The script that generates the README (`docs/Taskfile.yml` and its `markdown` task) appears to have changed its behavior or is missing logic to include existing documentation. The script should be fixed to correctly include the documentation for all actions and workflows. After fixing the script, regenerate the `README.md` to restore the lost documentation before merging.

---

Powered by Visor from Probelabs

Last updated: 2026-06-01T11:30:20.468Z | Triggered by: pr_opened | Commit: 529bcce

💡 TIP: You can chat with Visor using /visor ask <your question>