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

Add support for Org/Proj ID #2014

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Conversation

Dev-Khant
Copy link
Member

Description

Add support for Org/Proj ID. Also added the deprecation warning for names of Org/Proj it will be removed in version 0.1.40.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Made sure Checks passed

# Legacy approach (deprecated, will be removed in v0.1.40)
client = MemoryClient(
organization='YOUR_ORG_NAME', # Deprecated
project='YOUR_PROJECT_NAME', # Deprecated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't mention this in docs. You probably want to encourage using the org_id and project_id

});

// Legacy approach (deprecated, will be removed in v0.1.40)
const client = new MemoryClient({
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as above.

if self.organization:
kwargs["org_name"] = self.organization
if self.project:
kwargs["project_name"] = self.project
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please add a check to make sure that user doesn't pass all four.

@Dev-Khant Dev-Khant merged commit 4cc91d7 into main Nov 7, 2024
5 checks passed
@deshraj deshraj deleted the user/dev/add-support-for-org-proj-id branch November 7, 2024 05:23
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.

2 participants