Skip to content

README.md

Latest commit

 

History

History
19 lines (11 loc) · 2.2 KB

README.md

File metadata and controls

19 lines (11 loc) · 2.2 KB
Raw

OpenNWM website assets

Reviewed public static files for the OpenNWM website.

The private source repository remains OpenSpace-Lab/OpenNWM. This repository contains only the public website artifact; it is consumed under OpenNWM/ by the organization site to preserve the website address.

To enable the exact website address on the organization's Free plan, an organization owner must:

  1. Make only the organization website repository, OpenSpace-Lab/OpenSpace-Lab.github.io, public. Keep OpenSpace-Lab/OpenNWM private.
  2. Copy .github/organization-pages.yml from this repository into .github/workflows/pages.yml on the organization website repository's main branch.
  3. In that organization website repository, select Settings → Pages → Build and deployment → Source → GitHub Actions, then run Actions → Deploy OpenNWM website → Run workflow.

The organization workflow reads this public repository's main branch and places the reviewed static files at /OpenNWM/. It runs when the organization website's main branch changes, manually, and hourly at minute 17; scheduled runs can be delayed by GitHub. No private source access or deploy key is needed by that workflow.

Leave Pages disabled on this repository: its own project Pages address would be /OpenNWM-site/. The organization workflow template is intentionally outside .github/workflows/ so it does not run here.

The initial reviewed website files were pushed using B0B8K1ng. Automatic source-to-public synchronization is prepared but not enabled: the organization currently disallows deploy keys. An organization owner must allow deploy keys before a write key scoped to this repository can be configured as OPENNWM_SITE_DEPLOY_KEY in the private source repository. Until then, its workflow tests and uploads the reviewed artifact and reports that synchronization was skipped.

Once configured, synchronization preserves this README and .github/. Only reviewed website files are synchronized, and publication commits use the B0B8K1ng identity. Public files become live after the next organization website workflow run.