Skip to content
This repository was archived by the owner on Aug 21, 2024. It is now read-only.

Conversation

@barankyle
Copy link
Contributor

@barankyle barankyle commented Nov 9, 2022

Summary

Added configuration of site manifest and automatic reupload of manifest.

With the move to hosting client files from the storage provider, the site manifest file was
providing improper paths. The start_path was being read by the client as being under the
storage provider's domain, rather than the client domain, and the icon paths were not correct,
since the convention is to have client files under /client in the storage provider.

Most aspects of the site manifest are now configurable from clientSettings. 'name' uses
clientSettings.title; 'short_name' comes from a new field, clientSettings.shortTitle;
'start_url' explicitly adds a new field clientSettings.startPath onto config.client.url;
and the two icons are combined from clientSettings.icon192px and clientSettings.icon512px
with the cacheDomain.

client-setting.patch now pulls down the manifest from the storage provider, updates it with the
patched data, and pushes it back to the storage provider. The same basic thing is done during
run-builder.sh in a new script update-site-manifest.ts, but instead of pulling/pushing to the
storage provider, just updates the copy of the file in packages/client/public, as all of that
will be built and pushed to the storage provider in the client build process.

References

closes #insert number here

Checklist

  • If this PR is still a WIP, convert to a draft
  • ensure all checks pass
  • When this PR is ready, mark it as "Ready for review"
  • Changes have been manually QA'd
  • Changes reviewed by at least 2 approved reviewer

QA Steps

List any additional steps required to QA the changes of this PR, as well as any supplemental images or videos.

With the move to hosting client files from the storage provider, the site manifest file was
providing improper paths. The start_path was being read by the client as being under the
storage provider's domain, rather than the client domain, and the icon paths were not correct,
since the convention is to have client files under /client in the storage provider.

Most aspects of the site manifest are now configurable from clientSettings. 'name' uses
clientSettings.title; 'short_name' comes from a new field, clientSettings.shortTitle;
'start_url' explicitly adds a new field clientSettings.startPath onto config.client.url;
and the two icons are combined from clientSettings.icon192px and clientSettings.icon512px
with the cacheDomain.

client-setting.patch now pulls down the manifest from the storage provider, updates it with the
patched data, and pushes it back to the storage provider. The same basic thing is done during
run-builder.sh in a new script update-site-manifest.ts, but instead of pulling/pushing to the
storage provider, just updates the copy of the file in packages/client/public, as all of that
will be built and pushed to the storage provider in the client build process.
@barankyle barankyle force-pushed the configurable-webmanifest-path branch from 264c292 to c998085 Compare November 9, 2022 03:32
@barankyle barankyle merged commit 639c7d1 into dev Nov 10, 2022
@barankyle barankyle deleted the configurable-webmanifest-path branch November 10, 2022 20:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant