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

add github-pages workflow #394

Merged
merged 3 commits into from
Jul 16, 2024
Merged

add github-pages workflow #394

merged 3 commits into from
Jul 16, 2024

Conversation

mixmix
Copy link
Contributor

@mixmix mixmix commented Jul 1, 2024

deploy the docs yo

Comment on lines +32 to +33
# TODO: uncomment this before merge
# if: github.ref == 'refs/heads/main'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO - this will guard against whatever PRs deploying.
I want to test deploy so this is temp disabled

Suggested change
# TODO: uncomment this before merge
# if: github.ref == 'refs/heads/main'
if: github.ref == 'refs/heads/main'

- main
tags:
- 'v*.*.*'
- '!v*.*.*-*'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

protect against deploying RC candidates like v0.2.0-dev or v0.2.0-2

tags:
- 'v*.*.*'
- '!v*.*.*-*'
pull_request:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this means PRs run generate:docs - I guess this is important / good so we know if our production docs are gonna get wrecked?

@frankiebee frankiebee requested a review from johnnymatthews July 9, 2024 16:51
@frankiebee frankiebee added the documentation Improvements or additions to documentation label Jul 9, 2024
@johnnymatthews
Copy link
Contributor

Couple of questions:

  1. Is this deploying the SDK docs somewhere?
    a. If yes, where?
  2. Is there a preview of the site we can we before each deployment?

@mixmix
Copy link
Contributor Author

mixmix commented Jul 15, 2024

@frankiebee can you turn on GH-PAGES or give us the keys plz?

Copy link
Contributor

@frankiebee frankiebee left a comment

Choose a reason for hiding this comment

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

Great lets see if it works

@frankiebee frankiebee merged commit ead8b92 into main Jul 16, 2024
2 checks passed
@frankiebee frankiebee deleted the mixmix/gh_pages branch July 16, 2024 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants