adds skip option to deploy

[RodrigoCuryZup]

No description provided.

[snykbotzup]

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

✅ code/snyk check is complete. No issues have been found. (View Details)

[gitbotzup]

PR Summary

This pull request introduces a new SKIP_DEPLOY feature to the deployment workflow, allowing the process to skip deployments when no relevant changes are detected in the manifesto. The documentation has been expanded for several inputs, and the logic for handling deployments has been updated to support this new feature. Additionally, input handling and error management have been improved for better reliability and user experience.

---

Changed Files and Their Updates

1. README.md

• Summary of Changes:
  • Added documentation for the new SKIP_DEPLOY input, explaining its purpose (to skip deploys if the manifesto has not changed).
  • Expanded documentation for BRANCH, DYNAMIC_INPUTS, and WORKDIR inputs using collapsible details sections, providing more usage information and examples.
  • Updated the BRANCH input's default value and clarified its behavior.
  • These changes improve clarity and provide more comprehensive usage instructions for users.
• Security Concerns:
  • None identified.

2. action.yaml

• Summary of Changes:
  • Introduced a new SKIP_DEPLOY input (default: false) to allow skipping deploys when no manifesto changes are detected.
  • Modified the BRANCH input to have a default value of 'true' and added a conditional to the Checkout step so it only runs if BRANCH is not 'false'.
  • Updated the StackSpot Runtime Manager URL for the default environment.
  • Passed the SKIP_DEPLOY input as an environment variable to the runtime script.
  • These changes add conditional deploy skipping and improve input handling.
• Security Concerns:
  • If SKIP_DEPLOY is not properly validated, it could unintentionally skip necessary deployments.
    Reviewer Attention: Ensure that the logic for determining when to skip is robust and that SKIP_DEPLOY cannot be manipulated to bypass required deployments.

3. runtime.py

• Summary of Changes:
  • Added logic to support the SKIP_DEPLOY feature: introduced environment variable parsing for SKIP_DEPLOY.
  • Implemented functions to check with the StackSpot API if a deploy can be skipped (using a PATCH request).
  • If skipping is allowed (HTTP 423), the deploy tasks are cleared and a message is printed.
  • Improved error handling and output for the skip check.
  • These changes enable the action to programmatically skip deployments when no relevant changes are detected.
• Security Concerns:
  • The skip logic relies on the response from an external API. If the API is unavailable or returns unexpected results, it could cause deploys to be skipped incorrectly or fail.
    Reviewer Attention: Ensure robust error handling is in place and consider monitoring for unexpected API responses to prevent accidental skips or failures.

---

Security Advice & Points of Attention

• SKIP_DEPLOY Validation:
  Carefully review the logic that determines when a deployment should be skipped. Improper validation or unchecked manipulation of the SKIP_DEPLOY input could result in critical deployments being unintentionally skipped.

• External API Dependence:
  The skip logic depends on the StackSpot API's response. If the API is down or returns unexpected status codes, deployments may be skipped or fail. Ensure that error handling covers these scenarios and that there is logging or alerting for unexpected behavior.

• Input Handling:
  With the expanded and clarified input documentation, ensure that all input values are properly validated and sanitized to prevent misconfiguration or misuse.

---

Overall, this PR adds a valuable feature for deployment efficiency, but reviewers should pay special attention to the robustness of the skip logic and the handling of external API responses to avoid accidental deployment skips.
This is an AI-generated summary, which may be innacurate.
This aims only to assist human reviewers, and does not replace code reviews in any way.
Use responsibly and please submit any feedback to this form.