pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2024-12-12 11:00:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: update docs to use globs in includes

Browse source
This commit is contained in:
daimond113 2024-11-24 17:42:28 +01:00
parent 37a7c34084
commit b6a4d39c51
No known key found for this signature in database
GPG key ID: 3A8ECE51328B513C
4 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/src/content/docs/guides/publishing.mdx
View file

@ -12,15 +12,14 @@ Before you can publish a package, you must configure the required fields in your
### `includes` ### `includes`
The `includes` field is a list of files and directories that should be included The `includes` field is a list of globs that should be included in the package.
in the package.
```toml ```toml
includes = [ includes = [
"pesde.toml", "pesde.toml",
"README.md", "README.md",
"LICENSE", "LICENSE",
"init.luau", "src/**/*.luau",
] ]
``` ```

2
docs/src/content/docs/guides/roblox.mdx
View file

@ -99,7 +99,7 @@ includes = [
"pesde.toml", "pesde.toml",
"LICENSE", "LICENSE",
"README.md", "README.md",
"src", "src/**/*.luau",
] ]
[target] [target]

4
docs/src/content/docs/guides/self-hosting-registries.mdx
View file

@ -88,8 +88,8 @@ has access to the index repository. We recommend using a separate account
for this purpose. for this purpose.
<Aside> <Aside>
For a GitHub account the password **must** be a personal access token. For instructions on how to For a GitHub account the password **must** be a personal access token. For
create a personal access token, see the [GitHub instructions on how to create a personal access token, see the [GitHub
documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
The access token must have read and write access to the index repository. The access token must have read and write access to the index repository.
</Aside> </Aside>

6
docs/src/content/docs/reference/manifest.mdx
View file

@ -71,8 +71,8 @@ package cannot be published to the registry.
### `includes` ### `includes`
List of top-level files and directories to include in the package when List of globs to include in the package when publishing. Files and directories
publishing. Files not listed here will not be published. not listed here will not be published.
```toml ```toml
includes = [ includes = [
@ -80,7 +80,7 @@ includes = [
"README.md", "README.md",
"LICENSE", "LICENSE",
"init.luau", "init.luau",
"docs", "docs/**/*.md",
] ]
``` ```