Question 1

How do I set up Wiki Page Creator Action to publish release notes automatically?

Accepted Answer

Integrate it into a GitHub Actions workflow after generating markdown files, such as with Decathlon's release-notes-generator-action. Configure env vars like MD_FOLDER for the source and SKIP_MD to exclude files, as shown in the README example.

Question 2

Can Wiki Page Creator Action update or overwrite existing wiki pages?

Accepted Answer

Yes, it pushes markdown files to the wiki, which will overwrite existing pages with the same filenames. Ensure your workflow manages versioning or backups if needed to avoid unintended changes.

Question 3

What permissions does the GH_PAT token need for this action?

Accepted Answer

The token requires the 'repo' scope to clone and push to the wiki. The README provides a direct link to generate a token with the necessary permissions, especially for accessing SSO-enabled organizations.

Question 4

Wiki Page Creator Action vs manually editing the GitHub wiki—which is better?

Accepted Answer

This action automates pushes from CI/CD, making it ideal for generated content like release notes, while manual editing suits ad-hoc updates. Choose based on whether your documentation is workflow-driven or requires frequent human input.

Question 5

Is it possible to use this action with private repositories or organizations?

Accepted Answer

Yes, as long as the GH_PAT has access to the private repo. The action uses the token for authentication, so it works with both public and private repositories, including those with SSO, as mentioned in the README.

Question 6

How to handle multiple markdown files scattered across different folders?

Accepted Answer

Set MD_FOLDER to a parent directory or use workflow steps to consolidate files into one folder before running the action. It scans the specified folder recursively for .md files, but complex structures may require preprocessing.

Create a GitHub wiki page based on the provided markdown file

What is Create a GitHub wiki page based on the provided markdown file?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions