Skip to content

Commit

Permalink
Fix the location of versions.js (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ytdHuang
ytdHuang authored Nov 11, 2024
2 parents eaddad0 + 0889007 commit f15facb
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/workflows/CleanPreviewDoc.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Cleanup Preview Documentation

on:
pull_request:
types: [closed]

jobs:
cleanup-preview-doc:
runs-on: ubuntu-latest
steps:
- name: Checkout gh-pages branch
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Delete preview and history + push changes
run: |
if [ -d "previews/PR$PRNUM" ]; then
git config user.name "Documenter.jl"
git config user.email "[email protected]"
git rm -rf "previews/PR$PRNUM"
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:
PRNUM: ${{ github.event.number }}
2 changes: 1 addition & 1 deletion docs/src/.vitepress/config.mts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default defineConfig({
outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
head: [
['link', { rel: 'icon', href: 'REPLACE_ME_DOCUMENTER_VITEPRESS_FAVICON' }],
['script', {src: `/versions.js`}],
['script', {src: `/QuantumToolbox.jl/versions.js`}],
['script', {src: `${baseTemp.base}siteinfo.js`}]
],
ignoreDeadLinks: true,
Expand Down

2 comments on commit f15facb

@ytdHuang
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request updated: JuliaRegistries/General/119164

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.21.3 -m "<description of version>" f15facbe5aecd7eca9c15d3be588ffbb31cc0b4c
git push origin v0.21.3

Please sign in to comment.