-
Notifications
You must be signed in to change notification settings - Fork 52
Use GA Tracking ID from Environment Variable Instead of Hardcoding #253
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: adity1raut <araut7798@gmail.com>
❌ Deploy Preview for kmesh-net failed.
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Welcome @adity1raut! It looks like this is your first PR to kmesh-net/website 🎉 |
Summary of ChangesHello @adity1raut, I'm Gemini Code Assist1! 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! This pull request significantly enhances the security posture and maintainability of the Docusaurus website by refactoring the Google Analytics tracking ID implementation. Instead of hardcoding this sensitive identifier directly into the configuration, it now leverages environment variables, ensuring that the ID is managed externally and securely, particularly in CI/CD pipelines, and preventing its exposure in public repositories. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly replaces the hardcoded Google Analytics tracking ID with an environment variable, which is a significant improvement for security and configuration management. The changes are well-executed, including adding .env to the .gitignore file and updating the necessary dependencies. I have one suggestion for the .env.example file to prevent potential misuse of the example tracking ID.
| @@ -0,0 +1 @@ | |||
| GA_TRACKING_ID = "G-854W8PEZ1Z" No newline at end of file | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's great that you've added an example environment file. However, using a real-looking tracking ID like G-854W8PEZ1Z could lead to developers accidentally using it in their local or even production environments if they copy the file without modification. This could pollute the analytics data. It's better practice to use a placeholder value to make it clear that it needs to be replaced.
GA_TRACKING_ID="G-XXXXXXXXXX"
Pull Request Description
Summary
This PR Fixed #252 updates the Docusaurus configuration to replace the hardcoded Google Analytics tracking ID with an environment variable. This improves security and prevents committing analytics IDs directly to source control.
Changes Included
docusaurus.config.jsGA_TRACKING_IDModified Configuration Example
GitHub Actions Update