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

Change default folder to wiki #57

Closed
wants to merge 8 commits into from
Closed
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
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Write Rev
run: 'git log -1 --format="%H" > .github/wiki/Rev.md'
run: 'git log -1 --format="%H" > wiki/Rev.md'
- uses: ./
with:
# For now, you'll need to manually specify a GitHub token until we
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ jobs:
- uses: spenserblack/actions-wiki@<version>
with:
# Whatever directory you choose will be mirrored to the GitHub
# .wiki.git. The default is .github/wiki.
path: wiki
# github.com/user/repo.wiki.git. The default is the root wiki/ folder.
path: docs/wiki
```

<img align="right" alt="Screenshot of 'Create the first page' button" src="https://i.imgur.com/ABKIS4h.png" />
Expand Down Expand Up @@ -89,8 +89,8 @@ one of your GitHub Actions workflows.
- **`token`:** `${{ github.token }}` is the default. This token is used when
cloning and pushing wiki changes.

- **`path`:** The directory to use for your wiki contents. Default:
`.github/wiki`.
- **`path`:** The directory to use for your wiki contents. Default is root
`wiki/` folder.

- **`commit-message`:** The message to use when committing new content. Default
is `Update wiki ${{ github.sha }}`. You probably don't need to change this,
Expand Down
5 changes: 3 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ inputs:
default: ${{ github.token }}
path:
description: >-
The directory to use for your wiki contents. Default .github/wiki.
The directory to use for your wiki contents. Default is root "wiki"
folder.
required: true
default: .github/wiki
default: wiki
commit-message:
description: >-
The message to use when committing new content. Default is Update wiki
Expand Down
File renamed without changes.