Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
4 changes: 3 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
name: Build and Deploy DataJoint Book

# Run on pushes to the main branch and on pull requests
# Run on pushes to the main branch, on pull requests, and manual triggers
on:
push:
# Runs on pushes targeting the default branch
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
# Allows manual triggering from the Actions tab

env:
# `BASE_URL` determines the website served from, including CSS and JS assets
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,18 @@ Every time changes are pushed to the `main` branch, a GitHub Actions workflow:

You can monitor the build and deployment status via the badge at the top of this README or by viewing the [Actions tab](https://github.com/dimitri-yatsenko/datajoint-book/actions) in the repository. This automated CI/CD pipeline ensures that the published version always reflects the latest content in the repository.

### Manual Workflow Execution

You can also manually trigger the "Build and Deploy DataJoint Book" workflow from the GitHub Actions interface:

1. Navigate to the [Actions tab](https://github.com/dimitri-yatsenko/datajoint-book/actions) in the repository
2. Select the "Build and Deploy DataJoint Book" workflow from the left sidebar
3. Click the "Run workflow" button (on the right side)
4. Select the branch you want to run the workflow on (typically `main`)
5. Click "Run workflow" to start the build and deployment process

This is useful when you want to rebuild and redeploy the book without making a new commit, or when testing workflow changes on a feature branch.

# Contributions
We welcome and appreciate your contributions to this book, whether as a reviewer or as a contributor.
All contributions will be gratefully acknowledged.
Expand Down