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

fix(build_documentation): only start deploy-documentation job on main branch #99

Merged

Conversation

leahaeusel
Copy link
Contributor

Description and Context

This PR avoids an error in the deploy-documentation job in our build_documentation workflow when this workflow is manually triggered on a branch other than main. Before, this job would fail on such a branch because only the main branch is allowed to deploy to github-pages:
image

With this PR, the deploy-documentation job is only started if the workflow is triggered on the main branch and skipped on other branches:
image

Related Issues and Pull Requests

  • Closes
  • Blocks
  • Is blocked by
  • Follows
  • Precedes
  • Related to
  • Part of
  • Composed of

How Has This Been Tested?

Checklist

  • My commit messages mention the appropriate issue numbers (advised but optional).
  • I mention the appropriate issue numbers in this PR.
  • I updated documentation where necessary.
  • I have added tests to cover my changes.

Additional Information

Interested Parties

Possible reviewers:

Other interested parties:

@leahaeusel leahaeusel added the minor: quickfix Minor quickfix to circumvent the 24h rule label Jan 14, 2025
@leahaeusel leahaeusel merged commit b3eb040 into queens-py:main Jan 15, 2025
1 check passed
@leahaeusel leahaeusel deleted the avoid-error-in-deploy-documentation-job branch January 15, 2025 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor: quickfix Minor quickfix to circumvent the 24h rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants