Skip to content

📖 [Docs]: Update to docs #113

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

Merged
Marius Storhaug (MariusStorhaug) merged 4 commits into from
Apr 19, 2025
Merged

📖 [Docs]: Update to docs #113

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da37361
📝 [Docs]: Add expected repository structure section to README
MariusStorhaug Apr 19, 2025
6e2ea9e
📝 [Docs]: Add step to upload module artifact in README
MariusStorhaug Apr 19, 2025
fa2ea2a
📝 [Docs]: Update module manifest properties section in README for cla…
MariusStorhaug Apr 19, 2025
42fe9d6
Update README.md
MariusStorhaug Apr 19, 2025
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This step lets you add custom build logic to process or modify the module conten
1. **Copies the source code** of the module to an output folder.
1. **Builds the module manifest file** based on information from the GitHub repository and the source code. For more information, please read the [Module Manifest](#module-manifest) section.
1. **Builds the root module (.psm1) file** by combining source code and adding automation into the root module file. For more information, please read the [Root module](#root-module) section.
1. **Uploads the module artifact** so that it can be used in the next steps of the workflow.

## Usage

Expand All @@ -36,6 +37,10 @@ This step lets you add custom build logic to process or modify the module conten
| `Prerelease` | Allow prerelease versions if available. | `false` | `'false'` |
| `WorkingDirectory` | The working directory where the script runs. | `false` | `'.'` |

## Expected repository structure

The action expects the module repository to be structured similarly as [Template-PSModule](https://github.com/PSModule/Template-PSModule).

Comment thread
MariusStorhaug marked this conversation as resolved.
Outdated
## Root module

The `src` folder may contain a 'root module' file. If present, the build function will disregard this file and build a new root module file based on the source code in the module folder.
Expand Down Expand Up @@ -151,7 +156,7 @@ Linking the description to the module manifest file might show more how this wor

This action does not require any special permissions.

## Sources
## References

**Module manifest:**

Expand Down