Skip to content

ci: auto deploy the GitHub pages/docs on releases #659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 2, 2023

Conversation

evelikov
Copy link
Contributor

@evelikov evelikov commented Nov 22, 2022

This adds a workflow, that triggers on GitHub releases, building/deploying the docs only when needed.

For example:

  • release 2.17.0 - deployed
  • release 2.18.0 - deployed
  • release 2.17.1 - skipped

Notes:

  • with this merged, the gh-pages branch can be removed ... we should also remove va_win and revert-583-HierarchyInfo
  • this requires two small changes in the project settings
    • Settings -> Pages -> Build and deployment -> Source -> GitHub Actions
    • Settings -> Environment -> github-pages -> Add deployment branch rule -> Add "[0-9].[0-9][0-9].[0-9]" -> Add rule

This MR builds upon and supersedes #642. Notable changes:

  • NOTE: fetches the complete history, without this the tag sorting/selection is broken
  • uses the official github actions
  • builds the minimal set of libva and only as needed
  • pretty UI and URL in the Action

@dvrogozh
Copy link
Contributor

@evelikov : thank you for working on this change. Really appreciate. To which degree you have tested the PR? I wonder, did you try real deployment in your fork copy? If yes - can you post a link?

@evelikov
Copy link
Contributor Author

It was quite a hit and miss, until I got it right to be honest. Ultimately I removed everything, since my fork became a complete mess.

Please try the instructions in your fork and let me know if you hit any issues.

@evelikov
Copy link
Contributor Author

evelikov commented Nov 23, 2022

Here is an illustrative example:

@evelikov
Copy link
Contributor Author

The FreeBSD failure seems unrelated.

@evelikov
Copy link
Contributor Author

evelikov commented Dec 2, 2022

@dvrogozh is the above example and execution outline helpful? Is there anything I can do to move this forward?

@evelikov
Copy link
Contributor Author

evelikov commented Dec 7, 2022

@XinfengZhang @dvrogozh humble ping?

@evelikov
Copy link
Contributor Author

@dvrogozh @XinfengZhang is there anything more I can do here?

@XinfengZhang
Copy link
Contributor

LGTM, but have questions:

  1. from the comments https://github.com/intel/libva/pull/642/files#r999197827, looks @jangsc0000 met some problem with official https://github.com/actions/deploy-pages.
  2. after merging this PR, the actions only take effect with new tag generated? or with a new commit merged? expect the first one without duplicated deployment.

@evelikov
Copy link
Contributor Author

  1. from the comments https://github.com/intel/libva/pull/642/files#r999197827, looks @jangsc0000 met some problem with official https://github.com/actions/deploy-pages.

Their comment does not say what the problem is, so I have no idea. It just works in my testing.

  1. after merging this PR, the actions only take effect with new tag generated? or with a new commit merged? expect the first one without duplicated deployment.

I think you meant to say except instead of expect, correct?

The action will trigger only when a new release is made - either via the web UI aka https://github.com/intel/libva/releases/new or the CLI tools.

@XinfengZhang
Copy link
Contributor

I am expecting "the actions only take effect with new tag generated" (first option in this sentence) , sorry for confusing.

@evelikov
Copy link
Contributor Author

I am expecting "the actions only take effect with new tag generated" (first option in this sentence) , sorry for confusing.

@XinfengZhang the English in the above sentence is a bit broken, so I am not sure what you mean.

Are you aiming to correct your previous statement? Are you asking for the PR to be reworked? Something else?

@XinfengZhang
Copy link
Contributor

XinfengZhang commented Dec 16, 2022

I am expecting "the actions only take effect with new tag generated" (first option in this sentence) , sorry for confusing.

@XinfengZhang the English in the above sentence is a bit broken, so I am not sure what you mean.

Are you aiming to correct your previous statement? Are you asking for the PR to be reworked? Something else?

no, you already answered my question:

"The action will trigger only when a new release is made - either via the web UI aka https://github.com/intel/libva/releases/new or the CLI tools."

it is my expectation. thanks

@evelikov
Copy link
Contributor Author

Glad to hear. Anything else I can do to have this merged?

@evelikov
Copy link
Contributor Author

evelikov commented Feb 1, 2023

@XinfengZhang @dvrogozh humble poke - anything I can do to move this forward?

jangsc0000 and others added 3 commits February 2, 2023 15:16
This workflow picks the latest version tag (via sort -V -r) and deploys
it.

Signed-off-by: Emil Velikov <[email protected]>
We use some unorthodox handling of the version - we suffix a "pre1" or a
fourth digit in the meson case to indicate that. The top-level
meson.build already swaps the digit - saving that as liva_version
variable.

Use the variable, otherwise the docs will list the wrong version.

Signed-off-by: Emil Velikov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants