Skip to content

Commit

Permalink
Add deployment workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
WillHannon-MCB committed Sep 20, 2024
1 parent 3dc3829 commit 0b06fb7
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 5 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Deploy VitePress site to Pages

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]

jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x]

steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: "npm"
- run: npm ci
- run: npm run docs:build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .vitepress/dist
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.*
!.gitignore
!.github
!.vitepress
.vitepress/dist
.vitepress/cache
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

*This guide is still under active development.*

## TODO
I made this guide for biologists with moderate programming experience who want to improve the way they work. You'll learn how to organize your projects, use remote resources, create reproducible software environments, and build computational pipelines.

This guide was made with members of the [Bloom lab](https://jbloomlab.org/) in mind. In the future, I might expand this resource to apply to a more general audience.

- Copy editing each section
- Add more specific examples
- Host the website

## Developing

To develop **Bench to Byte**, you'll need to set up a few things. Specifically, you'll need two pieces of software: `Node.js` and `npm`. `Node.js` is an environment that allows you to run Javascript code on your computer. `npm` is a package manager that handles the Javascript libraries necessary to create this website.
Expand Down

0 comments on commit 0b06fb7

Please sign in to comment.