Skip to content

Commit

Permalink
chore(readme): deployment updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mxmlnwbr committed Nov 10, 2023
1 parent b27e447 commit 8273564
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This project serves as a platform to facilitate the creation, management, and vi

The motivation behind this project is to offer academic institutions an efficient mechanism to simplify the proposal submission, evaluation, and feedback cycles, thereby facilitating a smoother pairing of students with their respective supervisors.

## Requirements

## Installation

How to install the project:
Expand All @@ -30,6 +32,45 @@ npm run dev

The web app should now be visible on https://localhost:5000.

## Deployment

This section will guide you through the deployment process.

### Pre-requisites

- [Helm](https://helm.sh/) installed
- [kubectl](https://kubernetes.io/docs/tasks/tools/) installed

### Steps

- (dev): `npm run release:beta:dry` (to test)
- (dev): `npm run release:beta` (to deploy)
- (dev): `git push --follow-tags origin dev` (to push to dev branch)
- (Github): Actions generate a new docker image automatically with a new tag (e.g. v1.0.0-beta.1)
- (.env/doppler): Update the APP_VERSION environment variable to the new tag (e.g. v1.0.0-beta.1)
- (dev): `cd deploy/`
- (dev): `./_deploy_prod.sh diff` (to check the changes)
- (dev): `./_deploy_prod.sh apply` (to deploy to the production environment)
- New version is now deployed to the production environment on [https://theses.bf.uzh.ch/](https://theses.bf.uzh.ch/)

- After testing the new version in production, merge the dev branch into the main branch
- (main): `npm run release:dry` (to test)
- (main): `npm run release` (to deploy)
- (main): `git push --follow-tags origin main` (to push to main branch)
- (Github): Actions generate a new docker image automatically with a new tag (e.g. v1.0.0)
- (.env/doppler): Update the APP_VERSION environment variable to the new tag (e.g. v1.0.0)
- (main): `cd deploy/`
- (main): `./_deploy_prod.sh diff` (to check the changes)
- (main): `./_deploy_prod.sh apply` (to deploy to the production environment)
- New version is now deployed to the production environment on [https://theses.bf.uzh.ch/](https://theses.bf.uzh.ch/)

### Restart the app (if only Powerautomate Solution Update)

```bash
# Restart the app
kubectl rollout restart -n thesis-platform deployment thesis-platform
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Expand Down

0 comments on commit 8273564

Please sign in to comment.