{"id":28549219,"url":"https://github.com/keymanapp/shared-sites","last_synced_at":"2026-01-19T22:02:19.796Z","repository":{"id":196600840,"uuid":"696717565","full_name":"keymanapp/shared-sites","owner":"keymanapp","description":"Shared code across keyman.com sites","archived":false,"fork":false,"pushed_at":"2026-01-18T23:06:08.000Z","size":214,"stargazers_count":0,"open_issues_count":6,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-01-19T08:43:46.144Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keymanapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-26T09:53:58.000Z","updated_at":"2025-11-26T05:40:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1570ea4-45f0-496f-96e0-5ea886f112ce","html_url":"https://github.com/keymanapp/shared-sites","commit_stats":null,"previous_names":["keymanapp/shared-sites"],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/keymanapp/shared-sites","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keymanapp%2Fshared-sites","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keymanapp%2Fshared-sites/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keymanapp%2Fshared-sites/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keymanapp%2Fshared-sites/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keymanapp","download_url":"https://codeload.github.com/keymanapp/shared-sites/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keymanapp%2Fshared-sites/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28587078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T20:45:59.482Z","status":"ssl_error","status_checked_at":"2026-01-19T20:45:41.500Z","response_time":67,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-10T02:08:41.451Z","updated_at":"2026-01-19T22:02:19.789Z","avatar_url":"https://github.com/keymanapp.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shared-sites\n\nShared content across keyman.com sites and centralized management of website\nlaunch and configuration.\n\n## Centralized management of keyman.com sites\n\nThe local build.sh script allows you to clone, build, start, stop, and test\nall keyman.com sites with a single command.\n\nThe repositories are assumed to be in subfolders of the parent folder for\nthis repo, for example, the following folder layout is suggested:\n\n```\n/.../projects/keyman/\n  sites/\n    api.keyman.com/\n    keyman.com/\n    ...\n    shared-sites/\n    website-local-proxy/\n```\n\nTo see the full list of commands and repositories, run:\n\n```sh\n./build.sh --help\n```\n\nSome common commands are:\n\n```sh\n./build.sh clone      # Clone websites from GitHub into subfolders of parent folder\n./build.sh pull       # Switch to master and pull latest changes to websites, DELETES MERGED BRANCHES\n./build.sh configure  # Configure websites\n./build.sh clean      # Clean websites\n./build.sh build      # Build docker images\n./build.sh start      # Start Docker containers\n./build.sh stop       # Stop Docker containers\n./build.sh test       # Test websites\n```\n\nThese commands can be combined, e.g.\n\n```sh\n./build.sh configure,build,start,test\n```\n\nAnd can be limited to specific repos, e.g.:\n\n```sh\n./build.sh build,start:keyman.com,keymanweb.com\n```\n\n## Shared content\n\n### _common/\n\nAll shared server-side scripts should be placed in this folder.\n\nThe files in this folder and its subfolders are downloaded by `build.sh` on\nkeyman.com sites into the `/_common` folder on the site.\n\nThe `/_common/assets` folder is a clone of the top-level `/assets` folder with\ncorresponding hashed filenames for cache-busting purposes. Do not modify this\nfolder directly (see [`build.sh`](#buildsh) for details).\n\nDo not refer to files in the `/_common/assets` folder directly. Instead, use the\nPHP `Assets` class (`/_common/Assets.php`) to refer to the files.\n\n### assets/\n\nThe files on this folder are the source files for client-side content -- images,\nscripts, stylesheets, and the like. `/_common/assets`.\n\n### bootstrap.inc.sh\n\nThis script is downloaded from the GitHub repo by the `build.sh` script\nkeyman.com sites under the `/resource` folder. It is not run on this site.\n\n### `.bootstrap-registry`\n\nThis file is automatically generated by [`build.sh`](#buildsh). Any changes to\nit should be committed.\n\nThis file is used by keyman.com sites, both when downloading shared files (from\nthe `build.sh` bootstrapping), and in the `Assets` class (`/_common/Assets.php`)\nto reference client-side assets.\n\n## Infrastructure files\n\n### `build.sh`\n\nThis script _must_ be run whenever changes are made to files shared to\nkeyman.com sites. It rebuilds the `/_common/assets` folder and creates the\n`.bootstrap-registry` file.\n\nThis script is not the same as the `build.sh` script on keyman.com sites.\n\nThe command to run is:\n\n```sh\n./build.sh build-files\n```\n\n## Distribution of changes\n\n### Preparing changes\n\n1. Asset files should be placed in `/assets`. PHP scripts should be placed in\n   `/_common`. (Do not make changes in `/_common/assets`, as these files will be\n   repopulated by build.sh.)\n2. Run `build.sh` after changing any files under `/_common` or `/assets`, in\n   order to rebuild `.bootstrap-registry` and repopulate `/_common/assets`.\n3. Commit all changes to the repository, including the generated files in\n   `/_common/assets`.\n\n### Testing changes\n\n1. Open a pull request on a new branch. In build.sh on a keyman.com site, create\n   a new branch, and locate the `BOOTSTRAP_VERSION` line in build.sh. Set this\n   to the name of the new branch, e.g.\n\n   ```sh\n   readonly BOOTSTRAP_VERSION=chore/move-sentry-js-to-common\n   ```\n\n2. With this change in place, you can test the changes locally by deleting\n   `resources/.bootstrap-version` on the site, and running:\n\n   ```sh\n   ./build.sh stop start\n   ```\n\n   This will download and rebuild the bootstrapped files.\n\n### Deployment\n\n1. Finally, once the PR on shared-sites is approved and merged, the changes on\n   the main branch will need to be tagged with a release, e.g. `v0.17`, and the\n   keyman.com site `BOOTSTRAP_VERSION` references should be updated to refer to\n   the new tag instead of the PR branch. Then each site that needs the changes\n   will need a PR with the updated `BOOTSTRAP_VERSION`, e.g.\n\n   ```sh\n   readonly BOOTSTRAP_VERSION=v0.17\n   ```\n\n\u003e [!IMPORTANT]\n\u003e Make sure you don't merge a PR on a keyman.com site that points\n\u003e to a branch rather than a tag. Once the branch goes away, subsequent\n\u003e deployments will fail.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeymanapp%2Fshared-sites","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeymanapp%2Fshared-sites","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeymanapp%2Fshared-sites/lists"}