You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by "JeremyYao (via GitHub)" <gi...@apache.org> on 2026/01/15 18:27:32 UTC
[PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
JeremyYao opened a new pull request, #213:
URL: https://github.com/apache/daffodil-site/pull/213
### Context
During release of daffodil-vscode 1.5.0, we observed that the site for 1.5.0 (https://daffodil.apache.org/vscode/1.5.0/) doesn't have links to docs.
We observed that the workflow for creating documentation needed to be run manually as shown in https://github.com/apache/daffodil-site/actions/workflows/update-docs.yml.
I initiated a manual run to create docs for daffodil-vscode 1.5.0 https://github.com/apache/daffodil-site/actions/runs/21040291571 which failed as the flag --embed-resources isn't supported in pandoc versions below 3.x.x
### Description of Fixes
Updates the workflow dependencies install to utilize pandoc 3.8.3 (latest) which supports --embed-resources.
Change the formatting hint for specifying version syntax for both daffodil and daffodil-vscode respectively
### Validation performed
Workflows were tested on my fork's main branch for both daffodil-vscode and daffodil.
#### Commits
- https://github.com/JeremyYao/daffodil-site/commit/17dd5b02d6b1e21e923f14f7aa6c6323273a0cc3
- https://github.com/JeremyYao/daffodil-site/commit/8967c6df1ac3233a233294d5c90216d035a17337
#### Workflow runs
- https://github.com/JeremyYao/daffodil-site/actions/runs/21041785786
- https://github.com/JeremyYao/daffodil-site/actions/runs/21041357549
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695636934
##########
.github/workflows/update-docs.yml:
##########
@@ -31,7 +31,7 @@ on:
- daffodil-vscode.wiki
required: true
version:
- description: Version (e.g. v1.0.0-rc1)
+ description: Version (Daffodil ex. v4.0.0-rc1, Daffodil-vscode ex. 1.5.0)
Review Comment:
One more thing, I did notice that the original `Extract Version` doesn't seem to work for a string like this `v1.5.0`, as it doesn't contain a `-`which `-.*$` doesn't catch. I'll be including updates to extract version
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695571256
##########
.github/workflows/update-docs.yml:
##########
@@ -31,7 +31,7 @@ on:
- daffodil-vscode.wiki
required: true
version:
- description: Version (e.g. v1.0.0-rc1)
+ description: Version (Daffodil ex. v4.0.0-rc1, Daffodil-vscode ex. 1.5.0)
Review Comment:
I didn't notice the `Extract Version` step which normalizes the version number. I'll remove changes to this line. Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695547126
##########
.github/workflows/update-docs.yml:
##########
@@ -75,7 +75,17 @@ jobs:
- name: Install Dependencies
run: |
- sudo apt-get install -y libmxml-dev pandoc
+ sudo apt-get update
+ sudo apt-get install -y libmxml-dev
+
+ - name: Install Pandoc 3.8.3
+ run: |
+ PANDOC_VERSION=3.8.3
+ curl -L \
+ https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz \
+ | tar xz
+ sudo mv pandoc-${PANDOC_VERSION}/bin/pandoc /usr/local/bin/pandoc
+ pandoc --version
Review Comment:
Would it work to download the .deb (same link just with .deb instead of .tar.gz) and install that? Might be just a bit simpler than having to extract a tar and move files.
##########
.github/workflows/update-docs.yml:
##########
@@ -31,7 +31,7 @@ on:
- daffodil-vscode.wiki
required: true
version:
- description: Version (e.g. v1.0.0-rc1)
+ description: Version (Daffodil ex. v4.0.0-rc1, Daffodil-vscode ex. 1.5.0)
Review Comment:
You should be able use the same `vX.Y.Z-rcx` for both daffodil and vscode.
The "Extract Version" step expects the `version` input to include the `v` and `rcX` and strips them off.
I think this would be preferred for consistency, and also if vscode ever moves docs into the main repo (I think there was some discussion to do this?), then we can change the checkout action to just be
```
ref: $inputs.project
```
so that it checks out the tag instead of the wiki master branch.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695704593
##########
.github/workflows/update-docs.yml:
##########
@@ -75,7 +75,17 @@ jobs:
- name: Install Dependencies
run: |
- sudo apt-get install -y libmxml-dev pandoc
+ sudo apt-get update
+ sudo apt-get install -y libmxml-dev
+
+ - name: Install Pandoc 3.8.3
+ run: |
+ PANDOC_VERSION=3.8.3
+ curl -L \
+ https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz \
+ | tar xz
+ sudo mv pandoc-${PANDOC_VERSION}/bin/pandoc /usr/local/bin/pandoc
+ pandoc --version
Review Comment:
Yup it would work with the .deb file and would be simpler indeed.
Made the changes and did a quick validation workflow run. It seems to work w/ the change
https://github.com/JeremyYao/daffodil-site/actions/runs/21043333693/workflow
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao merged PR #213:
URL: https://github.com/apache/daffodil-site/pull/213
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "stevedlawrence (via GitHub)" <gi...@apache.org>.
stevedlawrence commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695655638
##########
.github/workflows/update-docs.yml:
##########
@@ -31,7 +31,7 @@ on:
- daffodil-vscode.wiki
required: true
version:
- description: Version (e.g. v1.0.0-rc1)
+ description: Version (Daffodil ex. v4.0.0-rc1, Daffodil-vscode ex. 1.5.0)
Review Comment:
Documentation is intended to be built for release candidates and reviewed as part of the release process (I guess we forgot to do that, should be added to release checklists). Updating documentation after a release is generally discouraged. Since the documentation wasn't built for 1.5.0 due to error, I would suggest just running the action with `v1.5.0-rc1` and it should do the right thing.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify version description hint and use Pandoc 3.8.3 in doc workflow [daffodil-site]
Posted by "JeremyYao (via GitHub)" <gi...@apache.org>.
JeremyYao commented on code in PR #213:
URL: https://github.com/apache/daffodil-site/pull/213#discussion_r2695636934
##########
.github/workflows/update-docs.yml:
##########
@@ -31,7 +31,7 @@ on:
- daffodil-vscode.wiki
required: true
version:
- description: Version (e.g. v1.0.0-rc1)
+ description: Version (Daffodil ex. v4.0.0-rc1, Daffodil-vscode ex. 1.5.0)
Review Comment:
One more thing, I did notice that the original `Extract Version` doesn't seem to work for a string like this `v1.5.0`, as it doesn't contain a `-`which `-.*$` doesn't catch. I'll be including updates to extract version (see https://github.com/JeremyYao/daffodil-site/actions/runs/21042968791)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org