Skip to content

Conversation

lantoli
Copy link
Collaborator

@lantoli lantoli commented Jan 10, 2025

Description

Initial plugin command with release workflow.

  • Example of release: v0.0.1-pre2
  • Plugin release has beed tested in Mac, Windows and Mint (based on Ubuntu).
  • "local" make target to run the plugin with CLI

Link to any related issue(s): CLOUDP-293949

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals I have added appropriate changelog entries.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@@ -0,0 +1,55 @@
CLI_SOURCE_FILES?=./cmd/plugin
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using Makefile instead of GNUmakefile as we don't need specific features

@@ -1,7 +1,6 @@
---
name: Create JIRA ticket for new issues
name: JIRA Tickets for GH Issues
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

common naming convention for GH actions

@lantoli lantoli marked this pull request as ready for review January 13, 2025 08:47
@lantoli lantoli requested a review from a team as a code owner January 13, 2025 08:47
.PHONY: clean
clean: ## Clean binary folders
rm -rf ./bin ./bin-plugin

Copy link
Collaborator Author

@lantoli lantoli Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

local make target

)

completionOption := &cobra.CompletionOptions{
DisableDefaultCmd: true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why these options?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using the same defaults as in example and kubernetes plugins

commands:
terraform:
description: Utilities for Terraform's MongoDB Atlas Provider
tf:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love the shorthand option tf

Copy link
Contributor

@EspenAlbert EspenAlbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

description: Utilities for Terraform's MongoDB Atlas Provider
version: $VERSION
github:
owner: $GITHUB_REPOSITORY_OWNER
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice usage of env-vars

@lantoli lantoli merged commit b78f0e0 into main Jan 13, 2025
6 checks passed
@lantoli lantoli deleted the CLOUDP-293949_initial_command branch January 13, 2025 12:03
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.

3 participants