This repository has been archived by the owner on Nov 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Adds GH Pages Workflow #69
Open
johnedquinn
wants to merge
12
commits into
partiql:main
Choose a base branch
from
johnedquinn:gh-pages-setup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
0043ea4
Fixes rendering
johnedquinn 5f35289
Adds GH Pages workflow
johnedquinn 00a79b0
Minor changes to workflow
johnedquinn c77ffbd
Minor changes to workflow, again
johnedquinn 58a2a1b
Minor changes to workflow, again x2
johnedquinn 02d6a52
Updates version and build
johnedquinn 05e4c58
Updates revision information
johnedquinn 7d0a144
Updates versioning method and updates documentation
johnedquinn b4bea4f
Modifies GH Pages workflow to run on main
johnedquinn 8d4bf1a
Adds Section Links/Anchors
johnedquinn 8655cba
Updates how we retrieve the current date for publication
johnedquinn 9d93fe1
Fails build when unable to grab the latest date.
johnedquinn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## | ||
# Publish HTML to GH Pages | ||
# - Runs the build script. | ||
# - Moves relevant artifacts to publishing directory | ||
# - Moves publishing directory contents to GH pages. | ||
## | ||
|
||
name: Publish to GH Pages | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
publish: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- run: ls | ||
- name: Build using Docker | ||
run: /bin/bash ./build-docker.sh | ||
- name: Move to Publish Directory | ||
run: | | ||
mkdir ./publish | ||
mv ./build/PartiQL-Specification.html ./publish/index.html | ||
mv ./build/images ./publish/ | ||
- name: Deploy to GH Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./publish |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
/.vscode/ | ||
/.idea/ | ||
|
||
# build | ||
build | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the Conversation note:
I know we have added this to the release process but will there be a situation where the latest commit is not corresponding to a tag, i.e., changes not released yet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, intentionally. So, when we automatically release to GH pages, it'll grab the tip-of-head's date. However, when we release a version, the exact commit will be tagged. Checking out that commit and running this will always give us the release date matching that of the tagged commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to clarify further: so the page that we will see in the website is not necessarily the released version? if so, would it make sense to automate the release and as part of that publish for website?