Qovery / Qovery/documentation

Issue on docs

Open Beginner friendly
#127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1
Forks
0
Avg merge
1d 9h
Merged PRs (30d)
11

Description

Path: /configuration/environment-variables

Might be a good idea to include built-in ENV VARs that Qovery inject for version control systems; I was looking for the git commit SHA, and found through AI in the docs, but it's never mentioned.

It says it's QOVERY_COMMIT_ID; Here's the AI assistant response:


The built-in variables list doesn't include a git commit SHA. Let me check the pipeline build phase and Dockerfile docs for build args.The documentation doesn't list a built-in environment variable exposing the git commit SHA during build. Let me do one more targeted check.Found it. The Datadog integration page shows $QOVERY_COMMIT_ID. Let me confirm.Qovery injects a built-in variable QOVERY_COMMIT_ID containing the git commit SHA. You can reference it in your service's environment variables (e.g., DD_VERSION=$QOVERY_COMMIT_ID) or pass it as a Docker build ARG in your Dockerfile to expose it during the build phase. Note that ARGS variables also influence build caching (see image-mirroring docs).

(Environment Variables)[/configuration/environment-variables]
(Build Phase / Pipeline)[/configuration/deployment/pipeline]
(Image Mirroring)[/configuration/deployment/image-mirroring]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the documentation page at /configuration/environment-variables and review how built-in environment variables are listed. Document QOVERY_COMMIT_ID as the git commit SHA variable, including the use case described in the issue, then verify the surrounding links to the pipeline and image-mirroring pages remain appropriate.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.