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

Fixes issue with Storybook deployment #222

Merged
merged 1 commit into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
on:
workflow_call:
repository_dispatch:
types:
- docs_publish
Expand All @@ -12,17 +11,16 @@ jobs:
name: Publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v3
- uses: actions/setup-node@v3

- name: Build documentation
run: make docs-build
- run: make docs-build

- run: touch ./build/docs/.nojekyll
Copy link
Contributor Author

Choose a reason for hiding this comment

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

One of the storybook files has a name that starts with an underscore and something about Jekyll was preventing that file from working.


- name: Deploy
if: success()
uses: crazy-max/ghaction-github-pages@v1
- if: success()
uses: crazy-max/ghaction-github-pages@v4
with:
target_branch: gh-pages
build_dir: ./build/docs
Expand Down
12 changes: 6 additions & 6 deletions README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,19 +181,19 @@ MIT
[coverage-image]: https://img.shields.io/coveralls/github/recurly/react-recurly.svg?style=flat-square

[docs]: https://recurly.github.io/react-recurly
[docs-component-recurly-provider]: https://recurly.github.io/react-recurly/?path=/docs/components-recurlyprovider--page
[docs-component-elements]: https://recurly.github.io/react-recurly/?path=/docs/components-elements--page
[docs-component-card-element]: https://recurly.github.io/react-recurly/?path=/docs/components-cardelement--default
[docs-hook-use-recurly]: https://recurly.github.io/react-recurly/?path=/docs/hooks-userecurly--page
[docs-hook-use-checkout-pricing]: https://recurly.github.io/react-recurly/?path=/docs/hooks-usecheckoutpricing--page
[docs-component-recurly-provider]: https://recurly.github.io/react-recurly/?path=/docs/components-recurlyprovider--docs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

All of these links now end with docs

[docs-component-elements]: https://recurly.github.io/react-recurly/?path=/docs/components-elements--docs
[docs-component-card-element]: https://recurly.github.io/react-recurly/?path=/docs/components-card-element--default
[docs-hook-use-recurly]: https://recurly.github.io/react-recurly/?path=/docs/hooks-userecurly--docs
[docs-hook-use-checkout-pricing]: https://recurly.github.io/react-recurly/?path=/docs/hooks-usecheckoutpricing--docs

[docs-recurly-js]: https://developers.recurly.com/reference/recurly-js/
[docs-recurly-js-elements]: https://developers.recurly.com/reference/recurly-js/#elements
[docs-recurly-js-billing-fields]: https://developers.recurly.com/reference/recurly-js/#billing-fields
[docs-recurly-js-token]: https://developers.recurly.com/reference/recurly-js/#getting-a-token
[docs-recurly-api]: https://developers.recurly.com/api

[demo]: https://recurly.github.io/react-recurly/?path=/docs/introduction-interactive-demo--page
[demo]: https://recurly.github.io/react-recurly/?path=/docs/introduction-interactive-demo--docs
[demo-src]: https://github.com/recurly/react-recurly/tree/main/demo
[card-element-demo.js]: https://github.com/recurly/react-recurly/demo/src/card-element-demo.js

Expand Down