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

refactor!: Update .env variables, and add support for conditional output. #100

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

Ta5r
Copy link
Contributor

@Ta5r Ta5r commented Mar 20, 2025

What

This PR updates environment variable names and descriptions, introduces new variables, updates integration tests accordingly, and modifies documentation to reflect these changes.

Why

These updates are required to support the robust URL PR by ensuring consistency in variable usage, improving clarity in documentation, and refining integration tests.

Related Issue(s):

How

  • Updated and added environment variables in the variable registry
  • Reordered access functions for better readability and maintainability
  • Updated integration tests to validate new and modified variables
  • Enhanced documentation to reflect changes in environment variables

Screenshots

Screenshot 2025-03-20 at 5 40 22 PM

Checklist

  • I have read the Contribution Guidelines.
  • My code is tested to the best of my abilities.
  • My code passes all lints (PHPCS, PHPStan, ESLint, etc.).
  • My code has detailed inline documentation.
  • I have added unit tests to verify the code works as intended.
  • I have updated the project documentation as needed.
  • I have added a changelog entry for my changes to CHANGELOG.md.

@Ta5r Ta5r marked this pull request as ready for review March 20, 2025 12:11
@Ta5r Ta5r requested a review from justlevine March 20, 2025 12:11
@justlevine justlevine changed the title Refactor: Updates Env variables name and desc. refactor!: Update .env variables, and add support for conditional output. Mar 21, 2025
Copy link
Collaborator

@justlevine justlevine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ta5r

I got a bit carried away at 3AM, and instead of just moving the variables around I refactored a lot of internals so:

  1. The only vars that get generated are the ones that are needed for the site.
  2. The Environment Variables table shows an indicator as to which ones are in the .env file.

image

PTAL and then check out the Integration test coverage and backfill any tests that may be needed on Generator or VariableRegistry now that it's been refactored (I only converted the tests so they would pass I didn't have time to take a look at the coverage changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants