Skip to content

ci: adjust workflow target of documentation build #46

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 1 commit into from
Apr 8, 2025

Conversation

johannaSommer
Copy link
Collaborator

Description

In line with our efforts to use the GitHub action resources mindfully, this PR proposes to run the documentation after a merge to main or on dispatch (with the click of a button), similar to the installation workflow.
Rationale:

  • this workflow is only relevant for a PR adding a documentation snippet or a new algorithm. Since this is the case for a smaller-ish portion of the PRs I would propose this change - if needed this can be run by the PR opening person or reviewer.
  • to catch any mistakes that might have been overlooked this is run once when a PR is merged to main. Even in the case where it fails, this is fine, as the documentation will only be built on a new release and we will be able to fix it until then.

Related Issue

None.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

None - the workflow target is tested already with the installation and works as intended.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Additional Notes

Quickly also added the permissions for the workflow in this PR - this is recommended by the GitHub security actions.

Copy link
Collaborator

@sharpenb sharpenb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it!

Copy link
Collaborator

@johnrachwan123 johnrachwan123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@johannaSommer johannaSommer merged commit 7ec063a into main Apr 8, 2025
9 checks passed
@johannaSommer johannaSommer deleted the ci/documentation-target branch April 8, 2025 08:59
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