| Message ID | 20211209230854.30755-1-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/1] github: Add action to update wiki | expand |
Hi! > Tested on my fork: > https://github.com/pevik/ltp/runs/4477321979?check_suite_focus=true > https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines#0-special-paragraph-for-testing Looks good: Acked-by: Cyril Hrubis <chrubis@suse.cz> > Next could be uploading metadata HTML and PDF to http://linux-test-project.github.io/. Yes please, that would be awesome!
Hi Cyril, > Hi! > > Tested on my fork: > > https://github.com/pevik/ltp/runs/4477321979?check_suite_focus=true > > https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines#0-special-paragraph-for-testing > Looks good: > Acked-by: Cyril Hrubis <chrubis@suse.cz> Thanks, merged! I'll also update doc/maintainer-patch-review-checklist.txt https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist See patch bellow if any wording needs to be changed, I forget to add it in the patch. > > Next could be uploading metadata HTML and PDF to http://linux-test-project.github.io/. > Yes please, that would be awesome! I'll do that soon. Where do we want to 1) store HTML and PDF 2) show links to it? We have 3 places and 3 git repositories https://github.com/linux-test-project/linux-test-project.github.com https://github.com/linux-test-project/ltp.wiki.git https://github.com/linux-test-project/ltp Kind regards, Petr diff --git doc/maintainer-patch-review-checklist.txt doc/maintainer-patch-review-checklist.txt index c7bb47810b..4e10dc514b 100644 --- doc/maintainer-patch-review-checklist.txt +++ doc/maintainer-patch-review-checklist.txt @@ -20,8 +20,9 @@ Commit messages should have After patch is accepted or rejected, set correct state and archive in https://patchwork.ozlabs.org/project/ltp/list/[LTP patchwork instance]. -Also update LTP WIKI (git URL https://github.com/linux-test-project/ltp.wiki.git) -if touch `doc/*.txt`. +Also update `.github/workflows/wiki-mirror.yml` script which mirrors +`doc/*.txt` to LTP wiki (git URL https://github.com/linux-test-project/ltp.wiki.git) +if new wiki page is added.
Hi! > I'll also update doc/maintainer-patch-review-checklist.txt > https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist > See patch bellow if any wording needs to be changed, I forget to add it in the patch. > > > > Next could be uploading metadata HTML and PDF to http://linux-test-project.github.io/. > > > Yes please, that would be awesome! > I'll do that soon. Where do we want to 1) store HTML and PDF 2) show links to it? > We have 3 places and 3 git repositories > https://github.com/linux-test-project/linux-test-project.github.com I would just put it into this repository and put some links on the front page. I do not think that it should be put into wiki or somewhere else.
> Hi! > > I'll also update doc/maintainer-patch-review-checklist.txt > > https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist > > See patch bellow if any wording needs to be changed, I forget to add it in the patch. > > > > Next could be uploading metadata HTML and PDF to http://linux-test-project.github.io/. > > > Yes please, that would be awesome! > > I'll do that soon. Where do we want to 1) store HTML and PDF 2) show links to it? > > We have 3 places and 3 git repositories > > https://github.com/linux-test-project/linux-test-project.github.com > I would just put it into this repository and put some links on the front > page. I do not think that it should be put into wiki or somewhere else. OK, makes sense. Kind regards, Petr
diff --git a/.github/workflows/wiki-mirror.yml b/.github/workflows/wiki-mirror.yml new file mode 100644 index 000000000..44a3e9ed7 --- /dev/null +++ b/.github/workflows/wiki-mirror.yml @@ -0,0 +1,53 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (c) Linux Test Project, 2021 + +name: "Mirror doc to wiki" + +on: + push: + branches: + - master + paths: + - 'doc/**' + +jobs: + mirror: + runs-on: ubuntu-latest + steps: + - name: Checkout LTP + uses: actions/checkout@v2 + with: + path: ltp + + - name: Checkout LTP wiki + uses: actions/checkout@v2 + with: + repository: "linux-test-project/ltp.wiki" + path: ltp.wiki + + - name: Copy files, push + run: | + git config --global user.email "actions@github.com" + git config --global user.name "Wiki mirror" + + dir="$GITHUB_WORKSPACE/ltp/doc/" + cd $dir + commit=$(git log --pretty=format:"%h (\"%s\")" -1 .) + + cd $GITHUB_WORKSPACE/ltp.wiki + + # Don't forget to update this list, keep it sorted + cp -v $dir/c-test-api.txt C-Test-API.asciidoc + cp -v $dir/c-test-tutorial-simple.txt C-Test-Case-Tutorial.asciidoc + cp -v $dir/library-api-writing-guidelines.txt LTP-Library-API-Writing-Guidelines.asciidoc + cp -v $dir/maintainer-patch-review-checklist.txt Maintainer-Patch-Review-Checklist.asciidoc + cp -v $dir/network-c-api.txt C-Test-Network-API.asciidoc + cp -v $dir/shell-test-api.txt Shell-Test-API.asciidoc + cp -v $dir/supported-kernel-libc-versions.txt Supported-kernel,-libc,-toolchain-versions.asciidoc + cp -v $dir/test-writing-guidelines.txt Test-Writing-Guidelines.asciidoc + cp -v $dir/user-guide.txt User-Guidelines.asciidoc + + git add . + # only commit if there are changes + git diff-index --quiet HEAD -- || git commit -m "Update to $commit" . + git push
Suggested-by: Smitop <se@smitop.com> Signed-off-by: Petr Vorel <pvorel@suse.cz> --- Hi, I have custom script for updating wiki, but I got fed up by running it. I thought it'd be done with git remote hooks, but they're not supported. Then I got hint from Smitop (most of the code is actually from him, thanks!). Tested on my fork: https://github.com/pevik/ltp/runs/4477321979?check_suite_focus=true https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines#0-special-paragraph-for-testing Next could be uploading metadata HTML and PDF to http://linux-test-project.github.io/. Kind regards, Petr .github/workflows/wiki-mirror.yml | 53 +++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/workflows/wiki-mirror.yml