Skip to content

Update docs workflows to publish to local repo - #2194

Merged
kjmichel merged 2 commits into
mainfrom
gh-pages-migration
Sep 15, 2026
Merged

kjmichel merged 2 commits into
mainfrom
gh-pages-migration

Conversation

@kjmichel

@kjmichel kjmichel commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Docs are currently pushed to two locations:

- name: Deploy to ghpages branch
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs-html
- name: Deploy to fair-chem.github.io
uses: peaceiris/actions-gh-pages@v4
with:
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
external_repository: FAIR-Chem/fair-chem.github.io
publish_branch: gh-pages
publish_dir: docs-html

  1. A gh-pages branch in this repo, which exposes them at https://facebookresearch.github.io/fairchem/ (notice that this is broken though!)
  2. The gh-pages branch of https://github.com/FAIR-Chem/fair-chem.github.io, which exposes them at https://fair-chem.github.io

This PR removes step 2 - updates will no longer go to fair-chem.github.io. It also fixes the broken site at https://facebookresearch.github.io/fairchem/ by setting the BASE_URL environment variable to this repo's name as expected by MyST (https://mystmd.org/guide/deployment#deploy-base-url).

@kjmichel kjmichel added documentation Improvements or additions to documentation patch Patch version release labels Sep 10, 2026
@meta-cla meta-cla Bot added the cla signed label Sep 10, 2026
@kjmichel
kjmichel marked this pull request as ready for review September 10, 2026 22:45
@kjmichel
kjmichel added this pull request to the merge queue Sep 15, 2026
Merged via the queue into main with commit 39b0030 Sep 15, 2026
27 checks passed
@kjmichel
kjmichel deleted the gh-pages-migration branch September 15, 2026 16:37
pull Bot pushed a commit to Stars1233/fairchem that referenced this pull request Sep 16, 2026
…thub.io/fairchem (facebookresearch#2199)

Find and replace of fair-chem.github.io with
facebookresearch.github.io/fairchem as a followup to facebookresearch#2194
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla signed documentation Improvements or additions to documentation patch Patch version release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants