Dfoulks/asciidoc by dfoulks1 · Pull Request #77 · apache/infrastructure-actions

dfoulks1 · 2024-12-03T17:09:27Z

Requesting to add the AsciiDoc action (builds Asciidoc files and commits to perscribed branch)

Uses

checkout@v3

Process

Checks out code
Installs nodejs + asciidoc packages
iterates through adoc files in $srcfiles
moves HTML and $assets to tempdir.
checks out new branch
cleans out cruft
commits new stuff to $dest branch

dfoulks1 · 2024-12-05T15:41:03Z

@janhoy: Thanks for the suggestion! I'll update it to asciidoc-slides

Co-authored-by: Jacob Wujciak-Jens <jacob@wujciak.de> Signed-off-by: dfoulks1 <48735727+dfoulks1@users.noreply.github.com>

dfoulks1

responding to comments

dfoulks1 · 2024-12-05T15:45:22Z

+          if [[ "$(echo $file | awk -F. '{print $NF}')" != "adoc" ]]; then
+            continue
+          fi
+          echo $file


This was all ripped from the pelican action. If there's a better / more GHA way to approach this, I'm 100% interested.

dfoulks1 · 2024-12-05T15:48:09Z

+          fi
+          echo $file
+          node convert-slides.js $file
+          mv $(basename $file .adoc).html "${{ inputs.tempdir }}"/ 


the basename command requires a suffix to strip.

dfoulks1 · 2024-12-05T15:50:45Z

+        git status
+        if git commit -m "Commit build products"
+          then
+              git push


this was pulled from the pelican action and has been tested against the infrastructure-presentations repo

…ctions into dfoulks/asciidoc

jsoref · 2025-02-05T18:05:19Z

+        )
+      working-directory: "${{ github.action_path }}"
+
+    - name: 


Please name your steps

jsoref · 2025-02-05T18:06:02Z

+    - name: 
+      shell: bash
+      run: |
+        mkdir "${{ inputs.tempdir }}"


Suggested change

mkdir "${{ inputs.tempdir }}"

: 'Some name for this step -- the same as the `name:` field -- so that users see this instead of just the first rather useless line of the step when looking at a workflow'

mkdir "${{ inputs.tempdir }}"

jsoref · 2025-02-05T18:09:15Z

+          fi
+          echo $file
+          node convert-slides.js $file
+          mv $(basename $file .adoc).html "${{ inputs.tempdir }}"/ 


Never use ${{ ... }} inside a run: block.

Always use:

env: tempdir: ${{ inputs.tempdir }} run: | ... echo "$tempdir"

jsoref · 2025-02-05T18:10:50Z

+        cp "${{ github.action_path }}/package.json" "${{ inputs.tempdir }}"
+        [ -d "${{ github.workspace }}/${{ inputs.assets }}" ] && cp -r "${{ github.workspace }}/${{ inputs.assets }}" "${{ inputs.tempdir }}" || echo "No ${{ inputs.assets }} found!"
+      working-directory: "${{ inputs.srcdir }}"
+


you can use to if: toJSON(inputs.publish) or something like that

jsoref · 2025-02-05T18:11:47Z

+        git status
+        if git commit -m "Commit build products"
+          then
+              git push


I think calling the input publish instead of pushToBranch is unfortunate.

… repo

…the output dir around

netomi · 2025-02-10T19:13:28Z

+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: '${{ inputs.srcdir }}/${{ inputs.output }}'
+    - name: Deploy to GitHub Pages[


seems like a typo at the end '[' ?

dave2wave · 2026-04-01T23:53:14Z

@dfoulks1 if you wish to finish this action then I suggest that you create a branch in the infrastructure-actions repository and move this code there. You can then create a Draft PR from the branch. This will have the advantage that we can test this using a real site like Incubator that uses asciidoc.

dfoulks1 · 2026-04-02T17:49:05Z

@dfoulks1 if you wish to finish this action then I suggest that you create a branch in the infrastructure-actions repository and move this code there. You can then create a Draft PR from the branch. This will have the advantage that we can test this using a real site like Incubator that uses asciidoc.

I'm curently using it as is in the infrastructure-presntations repo to test. let me pick this back up and over the finish line.

potiuk · 2026-04-04T17:38:53Z

Let me convert to a Draft then - this is a nice way to show when things ar ready to review (by using "make it ready for review"

potiuk · 2026-04-18T08:12:23Z

Closing - it's unlikely to be followed after more than a year. But if needs be - the branch can be restored.

dave2wave · 2026-04-18T14:18:34Z

Let's not close PRs from infrastructure staff.

potiuk · 2026-04-18T15:09:52Z

Sure. I would love ot hear from @dfoulks1 if he is going to work on it, otherwise, it makes ittle sense to keep it. @dfoulks1 ?

dave2wave · 2026-04-18T16:35:56Z

@dfoulks1 if you wish to finish this action then I suggest that you create a branch in the infrastructure-actions repository and move this code there. You can then create a Draft PR from the branch. This will have the advantage that we can test this using a real site like Incubator that uses asciidoc.

I'm curently using it as is in the infrastructure-presntations repo to test. let me pick this back up and over the finish line.

Two weeks ago in this PR.

potiuk · 2026-04-18T20:49:39Z

Missed it - sorry

dfoulks1 added 30 commits November 26, 2024 10:03

Working on an asciidoc action

5eee76d

Use node to install and not apt

caa4df7

No package file present yet, install packages by name

088342e

use bash to ls files

e7254b1

look for convert.js in the action path, not in the repo

c3d2f25

Updated the installed package list

2f2bbb3

Updated the installed package list again

d2996d0

convert-slides.js needs to be in the same directory as the adoc?

4b1d544

missing quotes on variables

03a9f1e

Better quotes this time

08ed942

split up the environment set up and the actual node command

e84241f

working on getting paths correct

50227f2

Working with the default directory

745a16d

Working with the default directory directive

2bed37c

directive typo

bd92ead

fixed variable name

bd5644a

added echo and modified the bash capture

4ad7b6d

Tweaked action order

1ec87e9

Testing ordering and working directory

b12b4b2

Generating asciidocs works

3b2aae7

Added some file extension checking

96af62a

Missed bash if ending

f4956dc

Bash syntax is not python syntax

088cf57

Bash syntax is still not python syntax

81127a9

Changed default tempdir

873156e

Switched order to verify tempdir is being created

2898a38

Fixed next step

264fa6f

Updated dest_branch name

54d2010

Set the working directory for all steps

e4a527f

Omit the working directory directive to return to the root of the repo

711c2c6

Apply suggestions from code review

3989dc2

Co-authored-by: Jacob Wujciak-Jens <jacob@wujciak.de> Signed-off-by: dfoulks1 <48735727+dfoulks1@users.noreply.github.com>

dfoulks1 commented Dec 5, 2024

View reviewed changes

assignUser mentioned this pull request Dec 5, 2024

chore(stash): only run test workflow on relevant changes #78

Merged

dfoulks1 added 6 commits January 6, 2025 11:12

asciidoc example

f52a17e

Streamlining asciidoc action to push straight to ghpages

d45f602

Merge branch 'dfoulks/asciidoc' of github.com:apache/infrastructure-a…

f4d1059

…ctions into dfoulks/asciidoc

Added shell to the run command to install npm in the artifact

15747a1

OF: Indentation typo

1af72cc

Added Working Directory to the npm install in lieu of a relative

c22adb5

jsoref reviewed Feb 10, 2025

View reviewed changes

dfoulks1 added 5 commits February 10, 2025 12:03

action.yml no longer needs the tempdir as it's no longer pushing to a…

2c2fb7b

… repo

Attempting to set the working dir as srcdir/output instead of moving …

cd362ac

…the output dir around

Updated workflow permissions to include pages

d1c09a4

Dialing back perms

92ff2dd

Adding permissions elsewhere

d6cabc6

netomi reviewed Feb 10, 2025

View reviewed changes

dfoulks1 added reviewed This actions has had at least one review new submission New custom action submission labels Sep 16, 2025

potiuk marked this pull request as draft April 4, 2026 17:38

potiuk closed this Apr 18, 2026

dave2wave reopened this Apr 18, 2026

	mkdir "${{ inputs.tempdir }}"
	: 'Some name for this step -- the same as the `name:` field -- so that users see this instead of just the first rather useless line of the step when looking at a workflow'
	mkdir "${{ inputs.tempdir }}"

Conversation

dfoulks1 commented Dec 3, 2024

Uses

Process

Uh oh!

dfoulks1 commented Dec 5, 2024

Uh oh!

dfoulks1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dave2wave commented Apr 1, 2026

Uh oh!

dfoulks1 commented Apr 2, 2026

Uh oh!

potiuk commented Apr 4, 2026

Uh oh!

potiuk commented Apr 18, 2026

Uh oh!

dave2wave commented Apr 18, 2026

Uh oh!

potiuk commented Apr 18, 2026

Uh oh!

dave2wave commented Apr 18, 2026

Uh oh!

potiuk commented Apr 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants