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.

Sign up for GitHub

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

Auto generation of markdown doc files and update the wiki. #2860

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+56 −0
Open

Auto generation of markdown doc files and update the wiki. #2860

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8eab773
Create update-wiki-docs.yml
derdanu Oct 20, 2024
1432dbc
Merge branch 'Azure:main' into main
derdanu Nov 8, 2024
4b85a36
Merge branch 'main' into main
wonwuakpa-msft Dec 5, 2024
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
56 changes: 56 additions & 0 deletions .github/workflows/update-wiki-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Update wiki docs

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

concurrency:
group: wiki
cancel-in-progress: true

permissions:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think more permissions need to be included?
permissions: contents: write pull-requests: write wiki: write

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"wiki" is an unknown permission key.

https://github.com/marketplace/actions/github-wiki-action

contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.23.1'

- name: Build Binary and generate doc markdown files
run: |
mkdir -p output
go build -o output/azcopy
cd output
./azcopy doc
cd doc
sed -i 's/\.md//' *

- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: build-artifacts
path: output/doc/

- name: Checkout Wiki
uses: actions/checkout@v4
with:
repository: ${{github.repository}}.wiki
path: ${{github.repository}}.wiki

- name: Push to wiki
run: |
set -e
cd $GITHUB_WORKSPACE/${{github.repository}}.wiki
cp -r ../../output/doc/* .
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git diff-index --quiet HEAD || git commit -m "action: wiki sync" && git push
Loading