A monorepo for TypeScript projects related to Synapse.org, a service provided by Sage Bionetworks.
We're using pnpm for dependency management and Nx for builds.
After cloning the repository, install dependencies with pnpm i.
You can build all packages with pnpm build.
You can test all packages with pnpm test.
For project-specific commands, see the relevant package.json in each project folder.
We're using pnpm workspaces to manage multiple projects.
├── ./apps - Standalone web applications
│ ├── ./portals - Generates sites for data portals. Contains configurations for each maintained portal.
│ ├── ./SageAccountWeb - Standalone client-only React application for managing a Sage Bionetworks user account
│ └── ./synapse-oauth-signin - Standalone client-only React application used to authenticate and consent to an app that uses Synapse OAuth2+OIDC services
├── ./projects - Libraries and utilities that may or may not be published to NPM
│ ├── ./synapse-react-client - React components and utilities used in Synapse.org and portals
│ ├── ./synapse-types - TypeScript definitions and utility functions for Synapse REST API objects
│ └── ./vite-config - Shared configuration files for Vite used by apps
└── ./shared - Configuration files that are referenced across all projects
The main branch contains to the development version all packages. All changes should be merged into main.
For those packages that are deployed to npm, the deployment will occur when the version is changed in the main branch. A tag of the form <projectName>/v<version> will be created and applied to the commit which was deployed. You can generate release notes for a particular release by going to the Releases tab, clicking "Draft a new release", picking the tag generated by the automatic release, and clicking "Generate release notes".
Sometimes, due to Synapse.org's deployment cadence, a hotfix must be based on an existing version of a package, rather than the latest version. To release a hotfix, create a branch based off of the tagged commit of the intended base version. Make your changes, and create a pull request to pull the hotfix into main. After your code is reviewed, change your local version of the package(s) to release to an appropriate value (e.g. 1.0.0-SWC-1234), and locally run pnpm -r publish. You will need to have configured your NPM credentials and have been granted access to publish our projects.
On the latest commit for a PR where changes will be merged to main, multiple jobs will be triggered in GitHub Actions.
All changed projects and their dependents will be built, linted, tested, and type-checked.
Additionally, the project Storybook(s) will be published to Chromatic, where each story will be tested and snapshotted. To reduce usage, this job only runs on pull requests that are "ready-for-review" i.e. not drafts. For this reason, please mark your pull request as a draft until these checks are necessary.
Some notes:
- If the test step fails, you can find the failed tests by downloading the artifacts from the job, which includes HTML reports of the tests.
- We currently have many warnings and errors emitted in each test, so we have configured each test run to silence the output. If you need to see these warnings and errors, remove the 'silent' parameter from the script or configuration file.