Skip to content

Align resource key and data file environment variables#92

Merged
Automation51D merged 2 commits into
mainfrom
feature/align-environment-variables
Jun 13, 2026
Merged

Align resource key and data file environment variables#92
Automation51D merged 2 commits into
mainfrom
feature/align-environment-variables

Conversation

@jwrosewell

@jwrosewell jwrosewell commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

This change aligns the environment variable names used by the examples with the convention shared across 51Degrees repositories.

  • KeyHelper checks the aligned 51DEGREES_RESOURCE_KEY name first as an environment variable or system property. The legacy TestResourceKey and SuperResourceKey names are retained and checked second, so existing setups keep working.
  • DataFileHelper checks the 51DEGREES_IPI_PATH name for an explicit data file path before searching the project space. An absolute path supplied on the command line still wins. The TestDataFile system property and the XML placeholders are unchanged.
  • Developer-facing messages now reference the aligned names and the README documents the resolution order.

Notes

  • GitHub workflow secret references are unchanged. An accompanying issue advises on the aligned secret naming.
  • The aligned names start with a digit, which POSIX shells do not accept in plain assignments. On Linux and macOS set them with the env command or pass them as system properties, for example mvn exec:java -D51DEGREES_RESOURCE_KEY=AAA.

Examples now check the aligned 51DEGREES_RESOURCE_KEY name
(environment variable or system property) before the legacy
TestResourceKey, and the aligned 51DEGREES_IPI_PATH name before
searching the project space for a data file. Developer-facing
messages and the README now reference the aligned names.
Examples now reference the shared configurator links, with
https://configure.51degrees.com/Wkqxf3Bs selecting the free tier
properties and https://configure.51degrees.com/hYzn3TV3 also
including the paid properties used by the examples. Paid feature
advisories share a common sentence pointing at
https://51degrees.com/pricing and the documentation makes the free
and paid property split explicit.
@jwrosewell jwrosewell force-pushed the feature/align-environment-variables branch from ce7ac51 to b45ce6b Compare June 12, 2026 12:27
@Automation51D Automation51D merged commit 0f4db80 into main Jun 13, 2026
@Automation51D Automation51D deleted the feature/align-environment-variables branch June 13, 2026 06:35
Jamesr51d added a commit that referenced this pull request Jun 16, 2026
Bring the merged dd-cleanup + dotnet-parity branch up to date with main
(env-var alignment #92, web styling #97, UTM links #95). 5 conflicts:

- DataFileHelper.java: union - kept PR#96 findAvailableDataFile + LITE/ASN
  constants AND main's IPI_PATH_ENV_VAR (used by getDataFileLocation).
- KeyHelper.java: took main (re-adds getOrSetSuperResourceKey + env-var
  alignment). NOTE: this reverses the earlier "drop SuperResourceKey" since
  main now owns it (still unused, but main's code).
- HtmlContentHelper.java: restored main's version. NOTE: reverses PR#96's
  deletion - the merged web examples (GettingStartedWebOnPrem, WebMixed)
  reference it again after the main merge.
- GettingStartedOnPrem.java: hybrid - kept "lookup" wording, took main's
  UTM-tagged property-dictionary URL (UTM lint workflow on main).
- 51Degrees-CloudMixed.xml: kept PR#96's repurposed mixed-cloud config.

Validated: no markers, mvn test-compile passes.
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