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

fix: env variable instructions on locally-api.md #3223

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

Dogacel
Copy link
Contributor

@Dogacel Dogacel commented Dec 26, 2023

Thanks for submitting a PR! Please check the boxes below:

  • I have run pre-commit to check linting
  • I have added information to docs/ if required so people know about the feature!
  • I have filled in the "Changes" section below?
  • I have filled in the "How did you test this code" section below?
  • I have used a Conventional Commit title for this Pull Request

Changes

Update the documentation for ENV variable.

How did you test this code?

I tried to use this environment variable but it did not affect anything. So checked the source code and realized the docs is out-dated. Seems like this flag is now called ENVIRONMENT.

https://github.com/Flagsmith/flagsmith/blob/93ea01ca8d4b927b2b244fe2d5e555f6a345126d/api/app/settings/common.py#L35C1-L39

Copy link

vercel bot commented Dec 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 27, 2023 2:27pm

Copy link

vercel bot commented Dec 26, 2023

@Dogacel is attempting to deploy a commit to the Flagsmith Team on Vercel.

A member of the Team first needs to authorize it.

@gagantrivedi
Copy link
Member

Hi @Dogacel thanks for the PR! Can you format the file with prettier?

@Dogacel
Copy link
Contributor Author

Dogacel commented Dec 27, 2023

Hi @Dogacel thanks for the PR! Can you format the file with prettier?

Done!

One thing to note, make lint doesn't fix auto-fixable issues so had to hack it by reverting the commit and re-commiting. Also make lint gives error on those files in my local:

[warn] package-lock.json
[warn] package.json
[warn] src/css/custom.css
[warn] Code style issues found in 3 files. Run Prettier to fix.

@gagantrivedi
Copy link
Member

Hi @Dogacel thanks for the PR! Can you format the file with prettier?

Done!

One thing to note, make lint doesn't fix auto-fixable issues so had to hack it by reverting the commit and re-commiting. Also make lint gives error on those files in my local:

[warn] package-lock.json
[warn] package.json
[warn] src/css/custom.css
[warn] Code style issues found in 3 files. Run Prettier to fix.

Yeah, We use pre-commit to run linters that auto-fix the code. make lint is mostly used to --check

@dabeeeenster dabeeeenster self-requested a review January 2, 2024 09:49
@dabeeeenster
Copy link
Contributor

Great catch! Thanks @Dogacel

@dabeeeenster dabeeeenster added this pull request to the merge queue Jan 2, 2024
Merged via the queue into Flagsmith:main with commit 4f2fa90 Jan 2, 2024
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants