Skip to content

Commit

Permalink
ci: Use GitHub Actions for Pages website deployments (#554)
Browse files Browse the repository at this point in the history
This change switches to the new GitHub Actions based Pages deployments
instead of using a separate branch to deploy the website. This should
keep the repository a little cleaner.
  • Loading branch information
jbmorley authored Jul 30, 2024
1 parent 12cd237 commit 2c4ebac
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 258 deletions.
38 changes: 28 additions & 10 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,33 @@ jobs:
- name: Install dependencies
run: scripts/install-dependencies.sh

- name: Update release notes
- name: Build website
run: |
scripts/update-release-notes.sh
scripts/build-website.sh
chmod -v -R +rX "_site/"
- name: Commit documentation
uses: stefanzweifel/git-auto-commit-action@v5
id: auto-commit
with:
branch: documentation
create_branch: true
push_options: --force
commit_message: "docs: Update release notes"
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3

website-deploy:

needs: website-build
if: ${{ github.ref == 'refs/heads/main' }}

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or the latest "vX.X.X" version tag for this action
25 changes: 8 additions & 17 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
# macOS
.DS_Store

# Xcode
xcuserdata/
**.xcuserdatad

# Builds
.DS_Store
.env
build
temp

# Editors
.nova

# Libraries
/.local

# Docs
docs/.jekyll-cache
docs/_site
/_site
/docs/.jekyll-cache
/docs/_site
/docs/releases
build
temp
xcuserdata/
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

1 change: 1 addition & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ GEM
webrick (1.7.0)

PLATFORMS
arm64-darwin-23
x86_64-darwin-20
x86_64-darwin-22
x86_64-linux
Expand Down
54 changes: 5 additions & 49 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,59 +1,15 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: Fileaway
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
email: [email protected]
description: ""
url: "https://fileaway.app"
baseurl: ""
twitter_username: jekyllrb
github_username: jekyll

# Build settings
theme: minima
plugins:
- jekyll-feed
destination: ../_site

defaults:
- values:
layout: "default"

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
177 changes: 0 additions & 177 deletions docs/releases/index.markdown

This file was deleted.

Loading

0 comments on commit 2c4ebac

Please sign in to comment.