|
|
@@ -6,8 +6,10 @@ Our team has explored various deployment options, ultimately selecting the metho
|
|
|
|
|
|
This guide is crafted for individuals who already have access to the Azure subscription. It provides step-by-step instructions for setting up a new Azure Web App, specifically tailored for staging environments. Note that the process for setting up a production environment is similar, but requires a distinct web app name.
|
|
|
|
|
|
+Deployments to Azure Web Apps are automated through GitHub Actions, forming an integral part of our Continuous Integration/Continuous Deployment (CI/CD) process. The CI/CD pipeline is configured to automatically trigger deployments upon merging changes into either the `staging` or `release` branches.
|
|
|
+
|
|
|
> [!NOTE]
|
|
|
-> The deployment process outlined here is already established and running, hosted on Azure and sponsored by the .NET Foundation. This guide serves primarily as a reference for maintainers in the event that a new deployment setup is required.
|
|
|
+> The deployment process outlined here is already established and running, hosted on Azure and sponsored by the .NET Foundation. This guide serves primarily as a reference for maintainers in the event that a new deployment setup is required.
|
|
|
|
|
|
### Setting up a new Azure Web App
|
|
|
|
|
|
@@ -77,6 +79,15 @@ The previous step will have added a GitHub Action to your repository, which migh
|
|
|
1. This workflow might also need to be added to the `master` branch if it is not already present.
|
|
|
1. Execute the workflow `stride-docs-staging-azure.yml`. Ensure you select the correct branch `staging` and click **Run workflow**. This action will deploy the website to the Azure Web App.
|
|
|
|
|
|
+### GitHub Actions
|
|
|
+
|
|
|
+- `stride-website-github.yml`: Enables manual deployment to GitHub Pages in a forked repository, primarily for showcasing updates.
|
|
|
+- `stride-docs-release-azure.yml`: Automates deployment to production upon merging changes into the `release` branch, with a manual trigger option also available.
|
|
|
+- `stride-docs-release-fast-track-azure.yml`: Provides manual deployment to production, bypassing the creation of artifacts.
|
|
|
+- `stride-docs-staging-azure.yml`: Facilitates automatic deployment to [staging](https://stride-doc-staging.azurewebsites.net/latest/en/index.html) when changes are merged into the `staging` branch, and includes a manual trigger option.
|
|
|
+- `stride-docs-staging-fast-track-azure.yml`: Allows for manual deployment to staging, skipping the creation of artifacts.
|
|
|
+- `stride-website-wiki.yml`: Deploys automatically to the GitHub Wiki upon changes being pushed to the `wiki` folder, with a manual trigger feature also available.
|
|
|
+
|
|
|
## Deployment to GitHub Pages
|
|
|
|
|
|
To showcase your updates, especially helpful for design changes pending review, you can deploy the docs website either to your infrastructure or to GitHub Pages, a free hosting service. Once deployed, share the link with us for review.
|
Vaclav Elias