DX: workflows including MyST NB and precommit added #9
Conversation
for more information, see https://pre-commit.ci
shenvitor
changed the title
|
Improved :) Ready to go~ |
pixi.toml
Outdated
| authors = ["Vitor Shen <17490173+shenvitor@users.noreply.github.com>"] | ||
| channels = ["conda-forge"] | ||
| description = "Add a short description here" |
There was a problem hiding this comment.
I think it's fine to leave out version and description for now. They're optional
https://pixi.sh/latest/reference/configuration/#version-optional
.github/workflows/deploy.yml
Outdated
| - uses: actions/setup-node@v4 | ||
| uses: actions/configure-pages@v5 | ||
| with: | ||
| node-version: 18.x | ||
| - name: Install MyST Markdown | ||
| run: npm install -g mystmd | ||
| - name: Build HTML Assets | ||
| run: myst build --html | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
| enablement: "true" |
There was a problem hiding this comment.
I think it's not needed. Never used it for any other ComPWA project and those work just fine.
For sure it's not needed in the build step 😅
There was a problem hiding this comment.
But seems like this is working fine too. I think I'll keep it for https://pages.github.com/
.github/workflows/deploy.yml
Outdated
| id: deployment | ||
| uses: actions/deploy-pages@v2 | ||
| path: ./_build/html | ||
|
|
There was a problem hiding this comment.
Building the pages with pixi run doc is still missing here. That's also what the with.path was originally for (not setup-pixi, that requires no arguments).
There was a problem hiding this comment.
Actually https://github.com/actions/upload-pages-artifact is also missing. That is where with.path should be used.
.github/workflows/deploy.yml
Outdated
| id: deployment | ||
| uses: actions/deploy-pages@v2 | ||
| path: ./_build/html | ||
|
|
There was a problem hiding this comment.
Actually https://github.com/actions/upload-pages-artifact is also missing. That is where with.path should be used.
Closes #7