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

Wiki Enablement & PR Template Creation #1

Merged
merged 3 commits into from
Aug 16, 2021
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
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- Thank you for submitting a Pull Request. Please fill out the template below.-->
## Overview/Summary

Replace this with a brief description of what this Pull Request fixes, changes, etc.

## This PR fixes/adds/changes/removes

1. *Replace me*
2. *Replace me*
3. *Replace me*

### Breaking Changes

1. *Replace me*
2. *Replace me*

## Testing Evidence

Please provide any testing evidence to show that your Pull Request works/fixes as described and planned (include screenshots, if appropriate).

## As part of this Pull Request I have

- [ ] Checked for duplicate [Pull Requests](https://github.com/Azure/ALZ-Bicep/pulls)
- [ ] Associated it with relevant [issues](https://github.com/Azure/ALZ-Bicep/issues), for tracking and closure. Also check [ADO](https://dev.azure.com/unifiedactiontracker/Solution%20Engineering/_queries/query/4e77ab8a-78b3-447c-87b6-237ad590219f/)
- [ ] Ensured my code/branch is up-to-date with the latest changes in the `main` [branch](https://github.com/Azure/ALZ-Bicep/tree/main)
- [ ] Performed testing and provided evidence.
- [ ] Updated relevant and associated documentation.
52 changes: 52 additions & 0 deletions .github/workflows/wiki-sync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Docs/Wiki Sync

on:
push:
branches:
- main
paths:
- "docs/wiki/**"

env:
wiki_source_repo: "Azure/ALZ-Bicep"
wiki_source_repo_dir: "Azure/ALZ-Bicep/docs/wiki"
wiki_target_repo: "Azure/ALZ-Bicep.wiki"
github_user_name: "github-actions"
github_email: "41898282+github-actions[bot]@users.noreply.github.com"
github_commit_message: "Wiki Sync from docs/wiki"

jobs:
sync-wiki:
name: Sync docs/wiki to Wiki
if: github.repository == 'Azure/ALZ-Bicep'
runs-on: ubuntu-latest
steps:
- name: Checkout Source Repo
uses: actions/checkout@v2
with:
repository: ${{ env.wiki_source_repo }}
path: ${{ env.wiki_source_repo }}

- name: Checkout Wiki Repo
uses: actions/checkout@v2
with:
repository: ${{ env.wiki_target_repo }}
path: ${{ env.wiki_target_repo }}

- name: Configure Local Git
run: |
git config --global user.name $github_user_name
git config --global user.email $github_email
working-directory: ${{ env.GITHUB_WORKSPACE }}

- name: Sync docs/wiki Into Wiki Repo
run: |
rsync -avzr --delete --exclude='.git/' "$wiki_source_repo_dir/" "$wiki_target_repo"
working-directory: ${{ env.GITHUB_WORKSPACE }}

- name: Stage & Push Files Into Wiki Repo
run: |
git add .
git commit -m "$github_commit_message [$GITHUB_ACTOR/${GITHUB_SHA::8}]"
git push --set-upstream https://$GITHUB_TOKEN@github.com/$wiki_target_repo.git master
working-directory: ${{ env.wiki_target_repo }}
3 changes: 3 additions & 0 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Azure Landing Zones Bicep - Staging Repo - Wiki

Welcome the wiki of the ALZ Bicep staging repo. This repo and wiki are only for the development of the ALZ Bicep implementation, once we have an MVP agreed and tested the contents of this repo will be migrated to the `Azure/Enteprise-Scale` repo.
4 changes: 4 additions & 0 deletions docs/wiki/_Footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**This wiki is being actively developed**
If you discover any documentation bugs or would like to request new content, please raise them as an [issue](https://github.com/Azure/ALZ-Bicep/issues).

Contributions to this wiki are done through the main repo under [docs/wiki](https://github.com/Azure/ALZ-Bicep/tree/main/docs/wiki).
4 changes: 4 additions & 0 deletions docs/wiki/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Wiki Navigation

* [Home](./Home)
* [Contributing](./Contributing)