CI: Refactor workflow file to build and publish Documentation website and Storybook simultaneously #1258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drikusroor
had a problem deploying
to
github-pages
GitHub Actions
Failure
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
changed the title
drikusroor
added
documentation
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Evert-R
approved these changes
Sep 10, 2024
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
…directory for generated pages
…directory for generated pages
drikusroor
force-pushed
the
docs/deploy-api-docs-storybook-pages
branch
from
2b7156d
to
3d004b3
Compare
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
drikusroor
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request refactors the workflow file to build and publish both the documentation and Storybook simultaneously.
Instead of directly artifacting and deploying the
frontend/storybook-staticdirectory, the workflow is now configured to create and use thedocs-pagesdirectory in the root of the repository which gets published to Github Pages. Storybook is then configured to publish its build intodocs-pages/storybookand update its internal links (config.base) to be prefixed with/MUSCLE/storybook/(MUSCLEis this repository's Github Pages' path,storybookis the subdirectory of storybook)I've created a dummy
index.htmlwith a link to the Storybook site that shows that it works: https://amsterdam-music-lab.github.io/MUSCLE. This should probably removed when the Documentation website is integrated into this workflow. So, remove these lines:MUSCLE/.github/workflows/docs.yml
Lines 31 to 35 in c15fe45
New directory / file structure for Github Pages
Important to know:
Currently, the workflow is configured to deploy for this branch too (besides
develop) in order to test the updated workflow.See the commented out condition for
refs/heads/develophere:MUSCLE/.github/workflows/docs.yml
Lines 59 to 62 in c15fe45
If I'm on vacation and @Evert-R wants to test the Documentation website being deployed to Github Pages correctly, it's probably a good idea to leave this turned on until we can verify it works as expected. BUT, Github Pages doesn't just publish from every git branch as there is a protection layer. So if you are trying to test your branch to be deployed correctly, you have to add your branch here (Settings > Environments > github-pages > Deployment tags & branches): https://github.com/Amsterdam-Music-Lab/MUSCLE/settings/environments/1801563345/edit