Skip to content
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

Use a separate GitHub Actions workflow to build offline documentation #4733

Merged

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Mar 8, 2021

This is required to get a permalink using https://nightly.link as we need the workflow containing the offline docs ZIP artifact to always be the latest one. Creating a second workflow is a good way to solve this.

This also makes it easier to distinguish between linting checks and offline documentation builds in the repository's Actions tab.

@Calinou Calinou marked this pull request as draft March 8, 2021 18:11
@Calinou Calinou force-pushed the ci-offline-docs-use-separate-workflow branch from 1d04ae8 to d33ac33 Compare March 9, 2021 18:36
This is required to get a permalink using https://nightly.link
as we need the workflow containing the offline docs ZIP artifact
to always be the latest one. Creating a second workflow is a good
way to solve this.

This also makes it easier to distinguish between linting checks
and offline documentation builds in the repository's Actions tab.
@Calinou Calinou force-pushed the ci-offline-docs-use-separate-workflow branch from d33ac33 to cdd15a1 Compare March 9, 2021 22:23
@Calinou Calinou marked this pull request as ready for review March 9, 2021 22:23
@Calinou
Copy link
Member Author

Calinou commented Mar 9, 2021

I added references to the generated artifact using nightly.link. These links won't work until this pull request has been merged and the workflow has been run once using the schedule defined on Monday at midnight (UTC).

You can test a link from my fork here: https://nightly.link/Calinou/godot-docs/workflows/build_offline_docs/ci-offline-docs-use-separate-workflow/godot-docs-html.zip

Due to this, I suggest we merge this pull request on a Sunday so that the link isn't invalid for too long 🙂

@Calinou Calinou merged commit 74ac839 into godotengine:master Mar 28, 2021
@Calinou Calinou deleted the ci-offline-docs-use-separate-workflow branch March 28, 2021 21:42
@Calinou
Copy link
Member Author

Calinou commented Mar 28, 2021

Cherry-picked to the 3.3, 3.2 and stable branches (with commits modified to have the URLs pertaining to each branch).

Calinou added a commit that referenced this pull request Mar 28, 2021
…#4733)

This is required to get a permalink using https://nightly.link
as we need the workflow containing the offline docs ZIP artifact
to always be the latest one. Creating a second workflow is a good
way to solve this.

This also makes it easier to distinguish between linting checks
and offline documentation builds in the repository's Actions tab.
Calinou added a commit that referenced this pull request Mar 28, 2021
…#4733)

This is required to get a permalink using https://nightly.link
as we need the workflow containing the offline docs ZIP artifact
to always be the latest one. Creating a second workflow is a good
way to solve this.

This also makes it easier to distinguish between linting checks
and offline documentation builds in the repository's Actions tab.
Calinou added a commit that referenced this pull request Mar 28, 2021
…#4733)

This is required to get a permalink using https://nightly.link
as we need the workflow containing the offline docs ZIP artifact
to always be the latest one. Creating a second workflow is a good
way to solve this.

This also makes it easier to distinguish between linting checks
and offline documentation builds in the repository's Actions tab.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant