docs/sdk-secret

[abbaseya]

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1210942136769386

[gemini-code-assist]

Summary of Changes

Hello @abbaseya, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've made several enhancements to the SDK, focusing on both functionality and documentation. This includes extending the GoalDataKey enum to support additional custom dimensions, updating the js-sdk README to clarify the usage of authenticated SDK keys, and refining a utility function for more robust numeric string validation. These changes aim to improve the SDK's capabilities and ensure clearer guidance for developers.

Highlights

• SDK Key Secret Documentation: Updated the js-sdk README to include guidance on using seksdkKeySecret for authenticated SDK keys, ensuring users are aware of this requirement.
• Goal Data Key Extension: Expanded the GoalDataKey enum to support five new custom dimensions, providing more flexibility for tracking goal-related data.
• Improved Numeric Validation: Refined the isNumeric utility function to more accurately validate numeric strings, including those with comma separators, enhancing data parsing robustness.
• Prettier Ignore Update: Added a new path to .prettierignore to prevent formatting issues in a specific configuration directory.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request aims to update the SDK documentation regarding authenticated keys. I've found a typo in the property name seksdkKeySecret which should be sdkKeySecret. This error is present in both the description and the code example, which would cause implementation issues for users. A correction is suggested.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud