Skip to content

Commit b4e51bf

Browse files
author
Paloma Oliveira
authored
Update Readme with Actions information
1 parent 40322a1 commit b4e51bf

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,29 @@ To run tests, run
120120
npm test
121121
```
122122

123+
## Enabling GitHub Actions for your organization
124+
125+
Under .github/workflows you will find 3 actions:
126+
- One that run tests on every commit
127+
And 3 others that: checks the repositories, overwrites the frontend.json file, sends it to frontend than deploys the new data to GitHub pages
128+
- One when a push is made to main branch
129+
- One daily at midnight (cron time)
130+
131+
It now uses Sauce Labs environment variables.
132+
You can change the information for your organization one by changing the following values (just for deployment actions):
133+
134+
```
135+
with:
136+
publish_branch: gh-pages
137+
user_name: 'OSS Sauce Bot'
138+
user_email: 'oss-sauce-bot@users.noreply.github.com'
139+
```
140+
141+
If you would like to know more about how to deploy Vue.js to GitHub pages and how to set up GitHub Pages from your repository, I recommend the following articles:
142+
- [Deploying Vue Apps to Github Pages, by Bobby](https://medium.com/swlh/deploy-vue-app-to-github-pages-2ada48d7397e)
143+
- [Vue CLI documentation](https://cli.vuejs.org/guide/deployment.html#general-guidelines) for deployment
144+
- [Getting started with GitHub Pages](https://docs.github.com/en/github/working-with-github-pages/getting-started-with-github-pages)
145+
123146
## Contributing
124147

125148
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our process for submitting pull requests, and please ensure you follow the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)