chore: workflow to deploy website to github pages #9
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
Adds a workflow that builds both the API docs and the playground application and deploys them to github-pages using the new actions-based deployment method. To make this work, Github Pages pages needs to be enabled and configured to allow deployments from actions. To do that, navigate to Settings > Code and automation > Pages, then in the section "Build and deployment" select "Github Actions" as the source. This will allow the `actions/deploy-pages` action to deploy new versions of the site. After deployment, the documentation will be available at https://googlemaps.github.io/js-adv-markers-utils and the playground will be at https://googlemaps.github.io/js-adv-markers-utils/playground The Google Maps API key needed for the playground application should be provided as a secret under the name `GOOGLE_MAPS_API_KEY` (the key can be limited to the referrer `https://googlemaps.github.io/js-adv-markers-utils/`) This has already been tested in my fork of the repository at https://usefulthink.github.io/js-adv-markers-utils/ and https://usefulthink.github.io/js-adv-markers-utils/playground
|
🎉 This PR is included in version 1.2.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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.
Adds a workflow that builds both the API docs and the playground application and deploys them to github-pages using the new actions-based deployment method.
To make this work, Github Pages pages needs to be enabled and configured to allow deployments from actions. To do that, navigate to Settings > Code and automation > Pages, then in the section "Build and deployment" select "Github Actions" as the source. This will allow the
actions/deploy-pagesaction to deploy new versions of the site.After deployment, the documentation will be available at https://googlemaps.github.io/js-adv-markers-utils and the playground will be at https://googlemaps.github.io/js-adv-markers-utils/playground
The Google Maps API key needed for the playground application should be provided as a secret under the name
GOOGLE_MAPS_API_KEY(the key can be limited to the referrerhttps://googlemaps.github.io/js-adv-markers-utils/*)This has already been tested in my fork of the repository, deployed versions available at https://usefulthink.github.io/js-adv-markers-utils/ and https://usefulthink.github.io/js-adv-markers-utils/playground