-
Notifications
You must be signed in to change notification settings - Fork 158
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
chore: add .env.example for easier environment setup and refine .gitignore #15
Conversation
@microsoft-github-policy-service agree company="Callstack" |
api/.env.example
Outdated
# To enable generating diffs for releases | ||
ENABLE_PACKAGE_DIFFING=false | ||
|
||
# To enable KeyVault credential resolution |
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.
Something is missing here.
@piotrski will you be finishing the PR please? |
@lucen-ms apologies, it must have slipped my mind. I'll take a look at this later today. |
I've updated the formatting of the .env.example file to make it cleaner and more organized. Additionally, I've added information indicating which variables are required, as you requested. Let me know if you have any feedback or if further adjustments are needed! |
Provide a template for environment variables to guide developers in configuring their local setup more easily.
e8d2703
to
a4f8835
Compare
api/.env.example
Outdated
# ============================== | ||
TEST_AZURE_STORAGE=false # Run API unit tests against Azure storage | ||
AZURE_STORAGE_ACCOUNT= # Storage account for testing (if TEST_AZURE_STORAGE=true) | ||
AZURE_STORAGE_ACCESS_KEY= # Storage access key for testing |
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.
AZURE_STORAGE_ACCOUNT= # Storage account for testing (if TEST_AZURE_STORAGE=true)
AZURE_STORAGE_ACCESS_KEY= # Storage access key for testing
This is duplication of the same settings above which will override them. Every setting should be only once in the example.
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.
You're right, I just removed them.
Thank you @piotrski for the contribution - I've merged your changes. |
I’ve made a couple of updates here to developer experience:
Added
.env.example
for easier environment setupThis provides a template for environment variables, helping developers get their local setup configured quickly.
Updated
.gitignore
to exclude Azurite local storage filesWe’ve added patterns to ignore Azurite's local storage files
(__azurite_db_*, __blobstorage__, __queuestorage__)
, keeping the working directory cleaner during local development.