Closed matthewhand closed 3 weeks ago
Conflicts?
should be fixed with #261. maybe you can rerun the CI? edit: nowait relates to gh-pages.yml. i will investigate and get back to you.
seems this file is special, potentially autogenerated when github pages is enabled. and for that reason it seems difficult (impossible?) to cleanly include the differences in this PR.
so I have removed .github/workflows/gh-pages.yml
from the PR, leaving just docs/tutorials/tips/contributing-tutorial.md
. I would have preferred an atomic commit. but given the special situation, it seems easiest if you just make the update on your end.
edit: ie, pass the envvar to npm like this...
- name: Build
env:
BASE_URL: ${{ vars.BASE_URL }}
SITE_URL: ${{ vars.SITE_URL }}
run: npm run build
Cherry-picked changes, Thanks!
Pull Request Title:
Add Contributing Guidelines and Update GitHub Pages Workflow with Environment Variables
Description:
This pull request introduces two contributions:
Contributing Guidelines:
docs/tutorials/tips/contributing-tutorial.md
.GitHub Pages Workflow Update:
.github/workflows/gh-pages.yml
to support forked repositories by introducing two new environment variables:SITE_URL
: Defines the custom site URL used for GitHub Pages deployment.BASE_URL
: Configures the base path for deployments.Files Added/Modified:
docs/tutorials/tips/contributing-tutorial.md
.github/workflows/gh-pages.yml
SITE_URL
andBASE_URL
environment variables to the deployment workflow to enable customized URLs for forked repositories.Steps to Validate:
Review the Contributing Tutorial:
docs/tutorials/tips/contributing-tutorial.md
is comprehensive and clear.Test the GitHub Pages Workflow:
SITE_URL
andBASE_URL
secrets to your forked repository.main
branch and confirm the deployment reflects the custom URLs.Checklist: