From 117de6246290eb22a8e449b01887f3cb8e96b2e8 Mon Sep 17 00:00:00 2001 From: michael-petersen Date: Tue, 5 Mar 2024 11:00:24 +0000 Subject: [PATCH] manually merge documentation to main --- .github/workflows/docpreviewcleanup.yml | 33 +++++++++++++++++++++++++ .github/workflows/documentation.yml | 26 +++++++++++++++++++ docs/make.jl | 2 +- 3 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docpreviewcleanup.yml create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/docpreviewcleanup.yml b/.github/workflows/docpreviewcleanup.yml new file mode 100644 index 0000000..36f8569 --- /dev/null +++ b/.github/workflows/docpreviewcleanup.yml @@ -0,0 +1,33 @@ +name: Doc Preview Cleanup + +on: + pull_request: + types: [closed] + +# Ensure that only one "Doc Preview Cleanup" workflow is force pushing at a time +concurrency: + group: doc-preview-cleanup + cancel-in-progress: false + +jobs: + doc-preview-cleanup: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Checkout gh-pages branch + uses: actions/checkout@v4 + with: + ref: gh-pages + - name: Delete preview and history + push changes + run: | + if [ -d "${preview_dir}" ]; then + git config user.name "Documenter.jl" + git config user.email "documenter@juliadocs.github.io" + git rm -rf "${preview_dir}" + git commit -m "delete preview" + git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree}) + git push --force origin gh-pages-new:gh-pages + fi + env: + preview_dir: previews/PR${{ github.event.number }} \ No newline at end of file diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..321bf8a --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,26 @@ +name: Documentation + +on: + push: + branches: + - main + tags: '*' + pull_request: + +jobs: + build: + permissions: + contents: write + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: '1.9' + - name: Install dependencies + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token + run: julia --project=docs/ docs/make.jl \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index 3ea5232..9db1ca5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -12,4 +12,4 @@ makedocs(sitename = "FiniteHilbertTransform.jl", ], format = Documenter.HTML(prettyurls=false)) -deploydocs(repo="github.com/JuliaStellarDynamics/FiniteHilbertTransform.jl",devbranch="documentation") \ No newline at end of file +deploydocs(repo="github.com/JuliaStellarDynamics/FiniteHilbertTransform.jl",devbranch="main") \ No newline at end of file