Skip to content

add deployment documentation #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mariamiah wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

add deployment documentation #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Spotlights Deployment

- The spotlights deployment is made via a github actions CI/CD pipeline.This runs the test, build and deployment stages.

## Github Actions Workflow

### Test Stage

- runs for every push and pull request on all branches

### Build Stage

- requires the test stage for it to run
- only runs for the master and develop branches
- runs the app build using `npm run build` and bundles specified files into one build folder
- stores the folder as a build artifact and the deploy_script in another deploy_script folder in github actions.
- clears the previous build folder on the server and downloads the build folder and deploy_script folder

### Deploy stage

- requires the build stage
- sets the `HOST` and `CMS_URL` environment variables based on the branch. These variables have to be added as github secrets
- unzips the deploy_script folder and executes the script in this folder