Issue1013

Title Migrate autodoc to GitHub Actions
Priority wish Status resolved
Superseder Nosy List florian, jendrik, malte, patfer, silvan
Assigned To patfer Keywords
Optional summary

Created on 2021-02-25.13:32:27 by patfer, last changed by patfer.

Messages
msg10143 (view) Author: patfer Date: 2021-02-26.13:46:43
It is merged and i added a sentence about this workflow to the wiki.
msg10141 (view) Author: malte Date: 2021-02-26.12:29:34
Looks good to me. Thanks, Patrick!
msg10140 (view) Author: patfer Date: 2021-02-26.12:05:23
Update: I shortly switched the condition to work on my repository and branch and added the page numbers to the atom-centric stubborn sets. The documentation was successfully update.

If you are ok, I will merge the issue.
msg10139 (view) Author: malte Date: 2021-02-26.10:48:09
Thanks! That's also what I got from the documentation.
msg10138 (view) Author: patfer Date: 2021-02-26.09:56:50
fix: ...the workflow should NOW (instead of not) run only ...
msg10137 (view) Author: patfer Date: 2021-02-26.09:55:58
Comments are incorporated. The workflow should not run only on "main" of "aibasel/downward". Not on any other branch or repository.

What happens on a push to multiple branches?
From my understanding and a quick testing:
if a branch is pushed, only the workflows defined in the branch itself are run.

From testing:
I created branches A & B with a workflow which is restricted to pushes on A. I created commits on both branches s.t.
- 1. commit on B, 2. commit on A, push --all (while on branch A). Runs the pipeline only for branch A.
- switched commit order (last commit not on the relevant branch A). Still runs workflow only on branch A.
-> that looks as we would like it.
msg10136 (view) Author: malte Date: 2021-02-25.16:46:46
Looks good to me! I left two polishing commits on github.

The majority of changes look unrelated to this issue, but I'm OK with including them. Since this is purely related to our workflow, I don't think it needs an entry in the change log, but feel free to add one anyway if you prefer.

I don't know how exactly the workflows work, but this should only ever be run on the new head revision of [main]. What does github do if a single push updates multiple branches? Run the workflow separately on each?

That is, I'm not sure how things like "this is on branch X" or "github.ref is branch X" are interpreted in practice if multiple branches are affected by a single push.
msg10135 (view) Author: patfer Date: 2021-02-25.15:28:59
There is a pull request now.
- autodoc.py uses now an environment variable & I can connect to the wiki from outside of the university
- the workflow successfully executes the script, BUT, till now I did not dare to put in the correct password (meaning it aborts when it receives an empty authentication token).

PR: https://github.com/aibasel/downward/pull/32
msg10134 (view) Author: patfer Date: 2021-02-25.13:32:27
Execute autodoc on GitHub actions and update the Wiki.
History
Date User Action Args
2021-02-26 13:46:43patfersetstatus: chatting -> resolved
messages: + msg10143
2021-02-26 12:29:34maltesetmessages: + msg10141
2021-02-26 12:05:23patfersetmessages: + msg10140
2021-02-26 10:48:09maltesetmessages: + msg10139
2021-02-26 09:56:51patfersetmessages: + msg10138
2021-02-26 09:55:59patfersetmessages: + msg10137
2021-02-25 16:46:46maltesetmessages: + msg10136
2021-02-25 15:29:00patfersetstatus: unread -> chatting
messages: + msg10135
2021-02-25 13:32:27patfercreate