Skip to content

Commit 7a33427

Browse files
David ZahaDavid Zaha
authored andcommitted
updated readme with automated workflow
1 parent 04f03c3 commit 7a33427

File tree

1 file changed

+2
-23
lines changed

1 file changed

+2
-23
lines changed

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ npm start
5454
## :outbox_tray: Deployment Instructions
5555
*[For the PR reviewer only]*
5656
57-
Pushing updates to the website from the main branch is a 2-step process:
57+
Pushing updates to the website from the main branch is a 1-step process:
5858
1. Push ***source code*** to the main branch:
5959
6060
Run the following commands on the terminal to push updates to the main branch
@@ -64,28 +64,7 @@ Pushing updates to the website from the main branch is a 2-step process:
6464
git push -f --set-upstream origin main
6565
```
6666
67-
2. Deploy website to github pages: Push ***website build*** to the `deployed` branch:
68-
69-
Run the following commands on the terminal to deploy the code on the main branch
70-
```
71-
git checkout main
72-
npm run deploy -- -m "Commit message"
73-
```
74-
This will automatically push the website *build* (instead of the source code) into the `deployed` branch already setup on Github. Github pages for this repository has been setup to display the build from the `deployed` branch.
75-
76-
The build steps are already set up in `package.json`:
77-
```
78-
{
79-
"homepage": "https://brainhack-vandy.github.io",
80-
...
81-
"scripts": {
82-
...
83-
"predeploy": "npm run build",
84-
"deploy": "gh-pages -b deployed -d build"
85-
},
86-
87-
}
88-
```
67+
Changes pushed to the main branch will result in an automated deployment action that will update the website.
8968
9069
---
9170
Design based on [@soumyajit4419/Porfolio](https://github.com/soumyajit4419/Portfolio) and [BrainHack Western](https://brainhackwestern.github.io/).

0 commit comments

Comments
 (0)