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

Update theme gem and document PLATFORM_NAME variable #786

Merged
merged 1 commit into from
Feb 9, 2024

Conversation

jazairi
Copy link
Contributor

@jazairi jazairi commented Feb 9, 2024

Why these changes are being introduced:

The GDT project added a feature to the theme gem to conditionally include the platform name in the header if the PLATFORM_NAME environment variable is supplied.

Relevant ticket(s):

https://mitlibraries.atlassian.net/browse/GDT-124

How this addresses that need:

This updates the theme gem to the v1.2 tag, which includes the new feature, and documents the PLATFORM_NAME variable.

Side effects of this change:

None. The app will continue to use the standard header if PLATFORM_NAME is not supplied.

Developer

  • All new ENV is documented in README
  • All new ENV has been added to Heroku Pipeline, Staging and Prod (Intentionally not setting the variable at this time, so we can decide when to make the change.)
  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • There are appropriate tests covering any new functionality
  • The documentation has been updated or is unnecessary
  • The changes have been verified
  • New dependencies are appropriate or there were no changes

Requires database migrations?

NO

Includes new or updated dependencies?

YES

@jazairi jazairi requested review from JPrevost and matt-bernhardt and removed request for JPrevost February 9, 2024 14:44
@JPrevost JPrevost self-assigned this Feb 9, 2024
Why these changes are being introduced:

The GDT project added a feature to the theme gem to conditionally
include the platform name in the header if the `PLATFORM_NAME`
environment variable is supplied.

Relevant ticket(s):

https://mitlibraries.atlassian.net/browse/GDT-124

How this addresses that need:

This updates the theme gem to the v1.2 tag, which includes the new
feature, and documents the PLATFORM_NAME variable. It also hides
the title in the navbar if PLATFORM_NAME is present.

Side effects of this change:

None. The app will continue to use the standard header if
PLATFORM_NAME is not supplied.
@jazairi jazairi force-pushed the add-app-name-to-header branch from 7f25e19 to fb8b70c Compare February 9, 2024 21:20
@jazairi jazairi temporarily deployed to timdex-pr-786 February 9, 2024 21:21 Inactive
@jazairi jazairi merged commit 369cd40 into main Feb 9, 2024
4 checks passed
@jazairi jazairi deleted the add-app-name-to-header branch February 9, 2024 21:24
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.

3 participants