https://github.com/clojure-finance/cryogen-action
Cryogen CI/CD Action for automating deployment.
https://github.com/clojure-finance/cryogen-action
Last synced: 6 months ago
JSON representation
Cryogen CI/CD Action for automating deployment.
- Host: GitHub
- URL: https://github.com/clojure-finance/cryogen-action
- Owner: clojure-finance
- License: mit
- Created: 2023-09-06T08:55:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T17:21:32.000Z (over 2 years ago)
- Last Synced: 2025-07-01T18:10:12.720Z (6 months ago)
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action - Cryogen CI/CD 🌱
Cryogen CI/CD Action for automating deployment.
This Github Action automating Cryogen deployment workflow, to allow you to leverage GitHub Actions to publish your Cryogen site on Github Pages.
## 🍑Usage
### 🍄Configuring the default `GITHUB_TOKEN` permissions
1. Click **Settings**.
1. In the left sidebar, click **Actions**, then click **General**.
1. Under "Workflow permissions", choose **Read and write permissions**.
1. Click **Save**.
For more information, please refer to the GitHub Help Documentation for [Configuring the default `GITHUB_TOKEN` permissions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions).
### 🍌Creating a workflow file
Create a workflow `.yml` file in your `.github/workflows` directory. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://docs.github.com/en/actions/using-workflows#creating-a-workflow-file).
**Example:** On every `push` to the `main` branch, generate Cryogen pages and publish to the `gh-pages` branch.
```yaml
name: Publish
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy
uses: clojure-finance/cryogen-action@v2
with:
folder: public/datajure-website
java-version: '11' # optional
java-distribution: 'liberica' # optional
lein-version: 2.10.0 # optional
branch: gh-pages # optional
single-commit: yes # optional
```
### 🌽Publishing from a branch
1. Click **Settings**.
1. In the "Code and automation" section of the sidebar, click **Pages**.
1. Under "Build and deployment", under "Source", select **Deploy from a branch**.
1. Under "Build and deployment", use the branch dropdown menu and select **`gh-pages`**.
1. Click **Save**.
For more information, please refer to the GitHub Help Documentation for [Publishing from a branch](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch).
## 🕊License
The scripts and documentation in this project are released under the [MIT License](LICENSE).