-
Notifications
You must be signed in to change notification settings - Fork 1
Deployment Configuration and Process
Here is a rundown of each environment, its corresponding Portal URL, and the associated GitHub branch. Pushing changes to any of the branches listed below will initiate an automatic re-build and re-deployment of the application:
| Environment | NDE PORTAL URL | GitHub Branch |
|---|---|---|
| Production | https://data.niaid.nih.gov | production |
| Staging | https://data-staging.niaid.nih.gov | main |
| Development | https://nde-dev.biothings.io | dev |
Relevant Strapi Admin interfaces and API endpoints are documented here.
For more details on setup, see the guide on configuring your environment.
You can view the different GitHub Actions here.
When you push a commit to any of the specified branches, automatic deployment executes the following build and testing commands:
-
yarn run build: Compiles the application for production. -
yarn run build:staging: Compiles the application for staging, omits post build commands. -
yarn run serve: Serves the compiled application. -
yarn run test: Runs the test suite to ensure code quality and functionality.
You can also run these commands locally. Be aware that the deployment will fail if any of these commands fail.
Some tests depend on external factors that may be beyond our control. For example, the "Check for broken links" test will fail if a link in a source is broken.
Although it is not recommended, you can choose to ignore any failing tests by adding 'skip test' to the commit message. This will cause the build to bypass any failed tests. For more details, refer to the deploy_prod.yml file on GitHub.
For most STRAPI content, changes made in the STRAPI CMS will automatically appear in the portal without requiring any code changes.
However, if the content update involves creating a new route (such as a dynamic page), refer to the documentation here.