Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish site via GitHub Actions #349

Merged
merged 3 commits into from
Mar 28, 2024
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
45 changes: 45 additions & 0 deletions .github/workflows/build_publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Build and Publish Site

on:
# allows us to run workflows manually
workflow_dispatch:
pull_request:
push:

jobs:
build-and-upload:
runs-on: ubuntu-latest

steps:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3

- name: Checkout cyclus.github.com
uses: actions/checkout@v4

- name: Build Site
run: |
make docker-html

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: gh-build

deploy:
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/source' }}
runs-on: ubuntu-latest
needs: build-and-upload

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ gh-publish:
make gh-publish-only

docker-gh-preview docker-html:
docker run -w /cyclus.github.com -v $(PWD):/cyclus.github.com cyclus/fuelcycle.org-deps bash -c "make gh-preview && chmod -R 777 $(BUILDDIR)"
docker build -f docker/fuelcycle.org-deps/Dockerfile -t fuelcycle.org-deps .
docker run -w /cyclus.github.com -v $(PWD):/cyclus.github.com fuelcycle.org-deps bash -c "make gh-preview && chmod -R 777 $(BUILDDIR)"

docker-gh-publish:
make clean
Expand Down
8 changes: 3 additions & 5 deletions docker/fuelcycle.org-deps/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@

FROM cyclus/cymetric
FROM ghcr.io/cyclus/cymetric_22.04_apt/cymetric:latest

RUN apt-get update
RUN apt-get install -y --force-yes wget
RUN apt-get install -y --force-yes python3-pip
RUN pip3 install sphinx sphinxcontrib-bibtex
RUN pip3 install cloud-sptheme==1.6
RUN apt-get install -y --force-yes wget python3-pip
RUN python -m pip install sphinx sphinxcontrib-bibtex cloud-sptheme==1.6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this pinning to preserve the sidebar menu? If so, let's add an issue to update our templates for a newer theme version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure why it is pinned at 1.6, that's just what was there. I'll make an issue regardless and try to resolve the sidebar complications.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's not for any reason, maybe let's drop the pin and see what we get?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dropped the pin and don't notice any significant changes (if any at all). If you want you can download the artifact generated by the action and check it out yourself! 😃

https://github.com/cyclus/cyclus.github.com/actions/runs/8461607773