Skip to content

add HiFiveUI, Review sharing - #3270

Open
pavoljurik wants to merge 1 commit into
Domain-Connect:masterfrom
pavoljurik:codex/hifiveui-review
Open

pavoljurik wants to merge 1 commit into
Domain-Connect:masterfrom
pavoljurik:codex/hifiveui-review

Conversation

@pavoljurik

Copy link
Copy Markdown

Description

HiFiveUI lets agencies share project reviews on a subdomain they own. This signed synchronous template points that subdomain at the HiFiveUI review service and adds an ownership TXT record under its own label. The DNS owner approves both records.

Product and logo: https://hifiveui.com/ and https://hifiveui.com/favicon.svg. Please use DNS-only for the CNAME on Cloudflare. The app supplies the host on every request.

Type of change

Please mark options that are relevant.

  • New template
  • Bug fix (non-breaking change which fixes an issue in the template)
  • New feature (non-breaking change which adds functionality to the template)
  • Breaking change (fix or feature that would cause existing template behavior to be not backward compatible)

How Has This Been Tested?

Please mark the following checks done

  • Template functionality checked using Online Editor
  • Template file name follows the pattern <providerId>.<serviceId>.json
  • resource URL provided with logoUrl is actually served by a webserver

Checklist of common problems

Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See Template Quality Guidelines for details and rationale on each rule.

  • syncPubKeyDomain is set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejected
  • warnPhishing is not set alongside syncPubKeyDomain — the two must not appear together
  • syncRedirectDomain is set whenever the template uses redirect_uri in the synchronous flow
  • no TXT record contains SPF content ("v=spf1 ...") — use the SPFM record type instead
  • txtConflictMatchingMode is set on every TXT record that must be unique per label or content prefix (e.g. DMARC)
  • no variable is used as a bare full record value (e.g. @ TXT "%foo%") unless necessary — prefer @ TXT "service-foo=%foo%"; if bare, justify in the PR description
  • no bare variable is used as the full host label — the non-variable parts are fixed to limit misuse (e.g. %dkimkey%._domainkey, not %dkimhost%); if bare, justify in the PR description
  • no variable is used in the host field to create a subdomain — use the host parameter or multiInstance instead
  • %host% does not appear explicitly in any host attribute
  • essential is set to OnApply on records the end user may need to modify or remove without breaking the template (e.g. DMARC)

The TXT proof is the entire value because the running service already generates the literal prefix hifive-review= followed by a random UUID. The DNS name and conflict prefix are fixed in the template. Both records must remain in place for verification. The synchronous flow uses no redirect URI. The official linter passed the full, automerge, logo, and Cloudflare-specific checks.

Online Editor test results

Editor test link(s):

Test hifiveui.com/review example.com/reviews

# Description

HiFiveUI lets agencies share project reviews on a subdomain they own. This signed synchronous template points that subdomain at the HiFiveUI review service and adds an ownership TXT record under its own label. The DNS owner approves both records.

Product and logo: https://hifiveui.com/ and https://hifiveui.com/favicon.svg. Please use DNS-only for the CNAME on Cloudflare. The app supplies the host on every request.

## Type of change

Please mark options that are relevant.

- [x] New template
- [ ] Bug fix (non-breaking change which fixes an issue in the template)
- [ ] New feature (non-breaking change which adds functionality to the template)
- [ ] Breaking change (fix or feature that would cause existing template behavior to be not backward compatible)

# How Has This Been Tested?

Please mark the following checks done
- [x] Template functionality checked using [Online Editor](https://domainconnect.paulonet.eu/dc/free/templateedit)
- [x] Template file name follows the pattern `<providerId>.<serviceId>.json`
- [x] resource URL provided with `logoUrl` is actually served by a webserver

# Checklist of common problems

Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See [Template Quality Guidelines](../README.md#template-quality-guidelines) for details and rationale on each rule.

- [x] `syncPubKeyDomain` is set — **this is mandatory**; omitting it requires explicit justification in the PR description or the PR will be rejected
- [x] `warnPhishing` is **not** set alongside `syncPubKeyDomain` — the two must not appear together
- [x] `syncRedirectDomain` is set whenever the template uses `redirect_uri` in the synchronous flow
- [x] no TXT record contains SPF content (`"v=spf1 ..."`) — use the `SPFM` record type instead
- [x] `txtConflictMatchingMode` is set on every TXT record that must be unique per label or content prefix (e.g. DMARC)
- [x] no variable is used as a bare full record value (e.g. `@ TXT "%foo%"`) unless necessary — prefer `@ TXT "service-foo=%foo%"`; if bare, justify in the PR description
- [x] no bare variable is used as the full `host` label — the non-variable parts are fixed to limit misuse (e.g. `%dkimkey%._domainkey`, not `%dkimhost%`); if bare, justify in the PR description
- [x] no variable is used in the `host` field to create a subdomain — use the `host` parameter or `multiInstance` instead
- [x] `%host%` does not appear explicitly in any `host` attribute
- [x] `essential` is set to `OnApply` on records the end user may need to modify or remove without breaking the template (e.g. DMARC)

The TXT proof is the entire value because the running service already generates the literal prefix `hifive-review=` followed by a random UUID. The DNS name and conflict prefix are fixed in the template. Both records must remain in place for verification. The synchronous flow uses no redirect URI. The official linter passed the full, automerge, logo, and Cloudflare-specific checks.

## Online Editor test results

<!--
  Required. Follow these steps in the Online Editor (https://domainconnect.paulonet.eu/dc/free/templateedit):
    1. Load your template and use "Check template" to perform extended schema and consistency check
    2. Fill in domain/host as well as variable values
    3. Click "Test apply template"
    4. Click "Copy Markdown" and paste the link below
    5. If necessary repeat steps 2-4 with different group setups and/or domain/host configuration
-->

**Editor test link(s):**

[Test hifiveui.com/review example.com/reviews](https://domainconnect.paulonet.eu/dc/free/templateedit?token=H4sIAAMWAWsC%2F%2B1UXWvbMBT9K0bQp9qJP%2BImNQxWsq%2B2tOtKOjpKMKp0nYjZkirJTt2Q%2Fz45sZOU9GHsaYz5wbbuvTrSOfdIS2SgkDk2gJIlkkpUjII6pyhBc5axCkrWI6JA7jZ3jQtbi76wTzZ7d24zGlTFCKwnKagYLHbBtvp2HXb0HCvGZzZdgdJMcJQELpoLbW7hqWQKLIRRJbiIgiaKSbOuQWPBORDjYEe1QOUjFQVm3MGcOhaMZbXDjHbEglvkOZO9Zg81Jzfl4yXUH9bFh6QUEKGoRsnDEplaNlsdX59dfUSbXdnh%2B4a6YNzoidjy0705i0vmyc2wBTMmR0l04vsrd4s2uZ%2FssNLN6t5WJIoNtvEjq63IjvYh7O%2BzsbSznBFzhQ2ZW92uBG0wbxRk7Bm9WdLmOqLtUu%2FQauqiXMzEncqbpDFSJ%2F3%2Bvhr9DNuGCd7T1QytXPQiOKQ7fex82okIz9h6BlraLblWGRuYKVHKlHXTJFa40I29OoCHVwjTDuJhizFd201kTew1Eb99vPVr0LxG3bB9AjS122czLhSk2n6xKRV0xirK3LAUL%2FAuREmKpcxry1bbrF300A184%2BMdybZ1v%2BUHF6WUNAKw5ohgOhwGfkg9TEjoDaIo8E7D0cgLwyEe0mgYBHS0d97eOotvnriDPoDWwA3DTcfP8gWuNVodWLMl9tqavQOef9CFv1SAqWtN%2Bb%2FB%2F3CD7e2hcQU0xU116IcnXhB4YTDxoyQeJIOoF0ZxEMfHvp%2F4fkMDtNnIsLQ3x%2F6dgchPOFeTC%2FM9j%2BXX8PN98CQvvl32L0%2FvtZYn4%2FhH8FIcxxSP6zN7yf4C0hlJmU4HAAA%3D)

<!-- paste the links from "Copy Markdown" here -->
<!-- REQUIRED: at last one test with domain apex and one test with subdomain (host set). EXCEPTION: if hostRequired=true, apex test is not required.
<!-- paste multiple links if more test conducted. At least 1 per template file included in the PR -->
@github-actions github-actions Bot added the hostRequired hostRequired is set label Nov 21, 2026
@github-actions

Copy link
Copy Markdown

✅ JSON Filename Check Passed

@github-actions

Copy link
Copy Markdown

✅ JSON Schema Validation Passed

@github-actions

Copy link
Copy Markdown

PR Description Check Passed

All required sections are filled in correctly.

Details
  OK  Type of change: 1/4 checkboxes ticked
  OK  How Has This Been Tested?: all 3 checkboxes ticked
  OK  Checklist of common problems: 10/10 checkboxes ticked
  OK  Online Editor test results: 1 link(s) found
  OK  Template coverage: all 1 template(s) covered
Labels to remove: Checklist of common problems not complete, Forged editor links, PR description incomplete, Test links missing

PR description check PASSED

@github-actions

Copy link
Copy Markdown

Linter OK

hifiveui.com.review.json

Level Code Note

@github-actions github-actions Bot added the automerge-possible Label indicating, that restrictive linter checks all pass. For now it's PoC. label Nov 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge-possible Label indicating, that restrictive linter checks all pass. For now it's PoC. hostRequired hostRequired is set

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant