Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename cli #25

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Rename cli #25

merged 2 commits into from
Feb 14, 2024

Conversation

dylanratcliffe
Copy link
Member

This should be merged once overmindtech/cli#175 is merged and released

@dylanratcliffe dylanratcliffe linked an issue Feb 14, 2024 that may be closed by this pull request
@dylanratcliffe
Copy link
Member Author

Tests should pass once we have a release to base on. Don't merge until the tests pass

Copy link

mapped Expected Changes

No expected changes found.

unmapped Unmapped Changes

Note

These changes couldn't be mapped to a real cloud resource and therefore won't be included in the blast radius calculation.

created null_resource › cluster
--- current
+++ planned
@@ -1 +1,2 @@
+terraform_address: null_resource.cluster
+terraform_name: cluster
created null_resource › network
--- current
+++ planned
@@ -1 +1,2 @@
+terraform_address: null_resource.network
+terraform_name: network

Blast Radius

items Items edges Edges
0 0

Open in Overmind

warning Risks

high Broken Dependency Links [High]

Given the renaming of ovm-cli to overmind and its repository from overmindtech/ovm-cli to overmindtech/cli, any automated or manual processes, scripts, CI/CD pipelines, or documentation referring to the old names might break as they can no longer resolve the correct resources. This risk is underscored by the absence of information about external dependencies or systems that might not have been updated alongside the changes highlighted in the PR. The direct implications are failed operations or misleading guidance due to unresolved references.

To mitigate this risk fully, we would need a comprehensive search across all codebases, documentation, and configuration files for references to ovm-cli or its old repository URL. Without confirming these updates, the risk remains relevant despite the changes proposed.

medium Misconfigured GitHub Actions [Medium]

The PR includes updates to GitHub Actions workflow files and action definitions, modifying the CLI tool's call from ./overmindtech/ovm-cli to ./overmindtech/overmind. Given that the proposed changes involve adjusting paths and commands, there's an inherent risk of typographical errors or incorrect path specifications that could result in failed GitHub Actions. This risk is specifically related to the correctness and accuracy of the changes and their execution paths. Ensuring that all paths and commands are valid and that the files are located where the scripts expect them to be is crucial. A mistake here could halt CI/CD processes, requiring immediate fixes and possibly affecting deployments or integrations.

Assuming the current configuration is working well, such adjustments are sensitive and need thorough validation to avert potential disruptions.

medium Download Issues Due to Filename Changes [Medium]

The filename pattern for the CLI tool download has been changed in install-cli/action.yml, adjusting from ovm-cli_*Linux_x86_64.tar.gz to overmind_cli_*Linux_x86_64.tar.gz. If the naming convention of released artifacts doesn't match this new pattern, the downloading process will fail, impacting setups relying on this action for installation. This risk is contingent on the actual release artifact names aligning with the expected pattern in the GitHub action. Without confirmation that the release artifacts are named accordingly, there's a risk of mismatches leading to failed installations.

Verification of the release artifacts' naming convention post-renaming would mitigate this risk. Until then, this proposed change maintains its relevance and potential for disruption.

low Incorrect Documentation Links [Low]

Updates made in README.md to reflect the new CLI name and repository could lead to navigation issues if the new URLs haven't been properly setup or reflected globally. This risk is minor compared to operational risks but is crucial for user experience and adoption. Broken or incorrect documentation links can deter users from successfully adopting or integrating the CLI tool, especially new users following setup instructions.

To ensure that documentation accurately guides users, validation of the new repository URLs and their accessibility is essential. This risk persists without confirmation that documentation points to valid and accessible endpoints.

@dylanratcliffe dylanratcliffe merged commit 1393806 into main Feb 14, 2024
2 checks passed
@dylanratcliffe dylanratcliffe deleted the rename-cli branch February 14, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move CLI calls to new naming scheme
1 participant