Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewmcodes/bridgetown-gh-pages-action
ARCHIVED See link below, this action is now longer needed following the release of Bridgetown V1
https://github.com/andrewmcodes/bridgetown-gh-pages-action
action actions github-action github-actions
Last synced: 3 months ago
JSON representation
ARCHIVED See link below, this action is now longer needed following the release of Bridgetown V1
- Host: GitHub
- URL: https://github.com/andrewmcodes/bridgetown-gh-pages-action
- Owner: andrewmcodes
- License: mit
- Archived: true
- Created: 2020-08-01T12:23:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-23T08:21:03.000Z (almost 3 years ago)
- Last Synced: 2024-09-16T23:19:50.834Z (4 months ago)
- Topics: action, actions, github-action, github-actions
- Language: Shell
- Homepage: https://andrewm.codes/deploy-bridgetown-to-github-pages/
- Size: 230 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 🚨 Archived
This action has been replaced by [Bridgetown v1.0's `gh-pages` bundled configuration](https://www.bridgetownrb.com/docs/bundled-configurations#github-pages-configuration) and has been archived. It will not be receiving any future updates and it is highly advised that you migrate to the action that Bridgetown now provides.
I have provided a tutorial for using the new action provided by Bridgetown below:
[➡️ How to Deploy Your Bridgetown Site to Github Pages (2022)](https://andrewm.codes/deploy-bridgetown-to-github-pages/)
Thank you to everyone who contributed their thoughts, time, and code to this project ❤️
bridgetown-gh-pages-action
A GitHub Action for building and deploying a Bridgetown site to GitHub Pages.
## Getting Started
This is intended to be an out-of-the-box solution for deploying your [Bridgetown](https://www.bridgetownrb.com) to [GitHub Pages](https://pages.github.com/).
```yml
- name: Build & Deploy to GitHub Pages
uses: andrewmcodes/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
**:rotating_light: IMPORTANT** Due to the way GitHub Actions work, you cannot pass in a Ruby version to the Docker container that gets built (or at least I can't find a way). **Due to this, this action will build your site with Ruby 2.7.1**. If you cannot upgrade your Ruby version for some reason, I suggest forking this action and adding the Ruby version you need in the Dockerfile, or using a [manual solution](#manual-solution).
## Usage
### Basic
```yaml
name: Deploy
on:
push:
branches: [main]
jobs:
build_and_deploy:
name: Build & Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build & Deploy to GitHub Pages
uses: andrewmcodes/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
### Advanced
```yaml
name: Deploy
on:
push:
branches: [main]
jobs:
build_and_deploy:
name: Build & Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build & Deploy to GitHub Pages
uses: andrewmcodes/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
repository: andrewmcodes/bridgetown-gh-pages-action
github_actor: octokit
site_location: "./site"
build_location: "./site/output"
deploy_branch: "deploy"
commit_message: "Release the site"
```
## Inputs
| Name | Type | Required? | Default | Description |
| -------------- | ------ | --------- | -------------------------- | ------------------------------------------------------------------------ |
| github_token | String | true | | Token for the repo. Can be passed in using \${{ secrets.GITHUB_TOKEN }}. |
| repository | String | false | `${{ github.repository }}` | The GitHub repository to push the built site to. |
| github_actor | String | false | `${{ github.actor }}` | Name of the deploy actor. |
| site_location | String | false | `.` | Location of the Bridgetown project within your repo. |
| build_location | String | false | `./output` | Location of your Bridgetown generated site. |
| default_branch | String | false | `main` | The name of your default branch. |
| deploy_branch | String | false | `gh-pages` | Branch name to push the site to. |
| commit_message | String | false | `chore: deploy site` | The commit message that will be used when deploying. |
## Manual Solution
If you cannot use this action due to version constraints or other issues, you can do this manually with something like:
```yaml
name: Deploy
on:
push:
branches:
- main
jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: "13.x"
- name: Get yarn cache directory path
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: Set up Ruby 2.7
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7.1
- name: Cache gems
uses: actions/cache@v1
with:
path: vendor/bundle
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
restore-keys: |
${{ runner.os }}-gems-
- name: Install Dependencies
run: |
bundle config path vendor/bundle
bundle install --jobs 4 --retry 3
yarn install
- name: Build site for deployment
run: yarn deploy
- name: Deploy to GitHub Pages
if: success()
uses: crazy-max/ghaction-github-pages@v2
with:
target_branch: gh-pages
build_dir: output
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Demo
[bridgetown-gh-pages-starter](https://github.com/andrewmcodes/bridgetown-gh-pages-starter)
This starter can be used to reproduce issues as well as provide an example of the plugin's usage.
You can view the live version at: [andrewmcodes.github.io/bridgetown-gh-pages-starter](https://andrewmcodes.github.io/bridgetown-gh-pages-starter/).
## Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/andrewmcodes/bridgetown-gh-pages-tag/issues). You can also take a look at the [contributing guide](https://github.com/andrewmcodes/bridgetown-gh-pages-tag/blob/main/CONTRIBUTING.md).
## Releasing
### Update Changelog
**Update**
```sh
conventional-changelog -p angular -i CHANGELOG.md -s
```
**Regenerate**
```sh
conventional-changelog -p angular -i CHANGELOG.md -s -r 0
```
## License
This plugin is released under the [MIT License](LICENSE).