Enable sof-docs deploy in GitHub Actions by xiulipan · Pull Request #321 · thesofproject/sof-docs

xiulipan · 2021-01-28T13:42:46Z

Disable Travis to avoid conflict.
Optimize and simplify GitHub Actions
Add new deploy job for publish branch

test with my own forked repo

deploy repo commit
https://github.com/xiulipan/xiulipan.github.io/tree/master
Action log
https://github.com/xiulipan/sof-docs/actions/runs/518058071
Final HTML
https://xiulipan.github.io/latest/index.html

TODO: we may need someone with admin to sof-docs to create a personal access token
and set a variable ACTIONS_DEPLOY_KEY as encrypted secrets for a repository.

guide are attached:
https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
(the only needed access is repo/public_repo)
https://docs.github.com/en/actions/reference/encrypted-secrets

Will use GitHub Action to do deploy. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

change the action name to better describe the job Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan · 2021-01-28T13:44:51Z

@lgirdwood @deb-intel Please check with my test repos if this deploy works for you.
NOTE: please move this out of DRAFT after you set the encrypted-secrets

lgirdwood

@xiulipan looks good + @intelkevinputnam for technical parts.
@xiulipan the next step is to integrate https://github.com/get-woke/woke as a CI action where @deb-intel will provide the config.

lgirdwood · 2021-01-28T14:46:46Z

@xiulipan looks good + @intelkevinputnam for technical parts.
@xiulipan the next step is to integrate https://github.com/get-woke/woke as a CI action where @deb-intel will provide the config.

@xiulipan sorry, by next step I mean "next step" schedule is after this PR is merged and maybe after CNY depending on your schedule.

intelkevinputnam · 2021-01-28T22:04:48Z

LGTM

marc-hb · 2021-01-29T01:49:45Z

+ name: html
+ path: _build/html
+
+ deploy:


Can we rename this to "publish"? Assuming I understood what it does.

I used the name from Travis scripts. @deb-intel and idea?

OK, the branch is called publish so my job name suggestion sounds not too far off the mark. deploy-job is another possibility.

use local action for duplicate code to replace the usage of YAML anchors. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

use the local action build-sof-doc.sh to build doc Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

merge ENV set up steps to make action steps more clean to understand use apt-get update for easy maintain, do not use binary as URL may be invalid. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan · 2021-01-29T07:16:22Z

@xiulipan looks good + @intelkevinputnam for technical parts.
@xiulipan the next step is to integrate https://github.com/get-woke/woke as a CI action where @deb-intel will provide the config.
@xiulipan sorry, by next step I mean "next step" schedule is after this PR is merged and maybe after CNY depending on your schedule.

@lgirdwood @deb-intel
I did a quick play with some existing GitHub action: https://github.com/marketplace/actions/run-woke-with-reviewdog
check detail xiulipan#1

lgirdwood · 2021-01-29T12:00:03Z

@lgirdwood @deb-intel
I did a quick play with some existing GitHub action: https://github.com/marketplace/actions/run-woke-with-reviewdog
check detail xiulipan#1

Looks good to me.

deb-intel · 2021-01-29T20:13:40Z

@xiulipan @lgirdwood Everything looks great!! We need to add two files: .wokeignore and rules-woke.yaml. I have created them already. They need to be placed at the top level, where .gitignore is located. .wokeignore lists all files to ignore when Woke is run. rules-woke.yaml lists customized rules that overwrite the default rules.

@xiulipan, do you want me to send the files to you via email or do you want me send them via a PR?

IMPORTANT: In order to run the customized file, the checks process must run the following: woke -c ./rules-woke.yaml

Please let me know if you have questions!

deb-intel · 2021-01-29T20:15:54Z

@xiulipan I did not know how to remove Draft mode. Sorry.

deb-intel

Looks great. Please see my comments.

xiulipan · 2021-02-01T03:23:00Z

@deb-intel Thanks for the woke configure things, Please send a PR for them first and I will do some personal test in my own repo with the woke. I will try to invite you for review at those testing PRs.

deb-intel · 2021-02-01T10:29:10Z

@xiulipan Done! See PR #322

marc-hb · 2021-02-01T19:16:23Z

If you are caring about this, I am totally OK to spilt the PR if you all think this is needed. This only a draft to test all my expected change to achieve the final goal here (move deploy from Travis to GitHub action)

Ping?

xiulipan · 2021-02-02T03:24:41Z

@deb-intel @lgirdwood I will leave this PR here as reference and start to address request from @marc-hb

use local action to create publish folder for local test Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

use public action https://github.com/marketplace/actions/github-pages-action to deploy HTML to our github.io repo when we make a push to publish branch Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan · 2021-02-02T03:51:35Z

@deb-intel @lgirdwood @marc-hb I spilt the PR into #323 and #324 But I think it would be better to merge this one if you think all issue is addressed. I found a dependency issue with deploy and build job name.

lgirdwood · 2021-02-02T10:21:57Z

@deb-intel @lgirdwood @marc-hb I spilt the PR into #323 and #324 But I think it would be better to merge this one if you think all issue is addressed. I found a dependency issue with deploy and build job name.

I'm OK with this, but I have no real experience with GH action so will wait for approvals from @marc-hb and @intelkevinputnam before merging. @marc-hb and @intelkevinputnam please make this a priority as Xiuli will be on vacation for Chinese New Year next week.

marc-hb · 2021-02-03T00:42:39Z

I spilt the PR into #323 and #324 But I think it would be better to merge this one if you think all issue is addressed. I found a dependency issue with deploy and build job name.

Thanks for the split. The dependency issue was a one-line change, #324 is running fine now.

xiulipan · 2021-02-03T03:35:14Z

@lgirdwood @marc-hb close now as we will move to #324 then #323

xiulipan added 2 commits January 28, 2021 10:05

CI: disable Travis to avoid depoly conflict
7325c10
Will use GitHub Action to do deploy. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

CI: GitHub: chagne the action name
31ae215
change the action name to better describe the job Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan requested review from deb-intel, lgirdwood and marc-hb January 28, 2021 13:51

lgirdwood reviewed Jan 28, 2021
View reviewed changes

Comment thread.github/actions/build-sof-doc.sh Outdated

marc-hb requested changes Jan 29, 2021
View reviewed changes

Comment thread.github/workflows/pull-request.yml
Comment thread.github/workflows/pull-request.yml
Comment thread.github/workflows/pull-request.yml Outdated

xiulipan added 2 commits January 29, 2021 02:17

CI: GitHub: add local action to build sof-doc
d26e4f8
use local action for duplicate code to replace the usage of YAML anchors. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

CI: GitHub: use the local action for sof-doc build
b47f572
use the local action build-sof-doc.sh to build doc Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan force-pushed the pr/ghdeploy branch 2 times, most recently from 7834d09 to f7b7252Compare January 29, 2021 06:57

CI: GitHub: simpify the steps
e69b60c
merge ENV set up steps to make action steps more clean to understand use apt-get update for easy maintain, do not use binary as URL may be invalid. Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

deb-intel marked this pull request as ready for review January 29, 2021 20:01

deb-intel requested a review from intelkevinputnam as a code owner January 29, 2021 20:01

deb-intel approved these changes Jan 29, 2021
View reviewed changes

lgirdwood approved these changes Feb 1, 2021
View reviewed changes

This was referenced Feb 2, 2021
optimization for GitHub Actions #323
Closed
Enable sof-docs deploy in GitHub Actions #324
Merged

xiulipan force-pushed the pr/ghdeploy branch from f7b7252 to fdfb138Compare February 2, 2021 03:50

xiulipan added 2 commits February 2, 2021 03:50

CI: GitHub: add local action to create publish folder
74066cb
use local action to create publish folder for local test Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

CI: GitHub: enable action to deploy
fdfb138
use public action https://github.com/marketplace/actions/github-pages-action to deploy HTML to our github.io repo when we make a push to publish branch Signed-off-by: Pan Xiuli <xiuli.pan@linux.intel.com>

xiulipan closed this Feb 3, 2021

Uh oh!

Conversation

xiulipan commented Jan 28, 2021

Uh oh!

xiulipan commented Jan 28, 2021

Uh oh!

lgirdwood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lgirdwood commented Jan 28, 2021

Uh oh!

intelkevinputnam commented Jan 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marc-hbJan 29, 2021

Choose a reason for hiding this comment

Uh oh!

xiulipanJan 29, 2021

Choose a reason for hiding this comment

Uh oh!

marc-hbJan 29, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xiulipan commented Jan 29, 2021

Uh oh!

lgirdwood commented Jan 29, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

deb-intel commented Jan 29, 2021

Uh oh!

deb-intel commented Jan 29, 2021

Uh oh!

deb-intel left a comment

Choose a reason for hiding this comment

Uh oh!

xiulipan commented Feb 1, 2021

Uh oh!

deb-intel commented Feb 1, 2021

Uh oh!

marc-hb commented Feb 1, 2021

Uh oh!

xiulipan commented Feb 2, 2021

Uh oh!

xiulipan commented Feb 2, 2021

Uh oh!

lgirdwood commented Feb 2, 2021

Uh oh!

marc-hb commented Feb 3, 2021

Uh oh!

xiulipan commented Feb 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lgirdwood commented Jan 29, 2021•
edited
Loading