Exclude Javadoc jars from primary files by default (#18)

* Exclude javadoc jar in code

* Update README.md

Co-authored-by: Kir_Antipov <kp.antipov@gmail.com>
This commit is contained in:
Cadiboo 2022-08-21 22:05:25 +10:00 committed by GitHub
parent 9342207fee
commit 81693dea8e
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS.
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 13 deletions

View file

@ -59,8 +59,8 @@ jobs:
github-discussion: Announcements github-discussion: Announcements
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
files-primary: build/libs/!(*-@(dev|sources)).jar files-primary: build/libs/!(*-@(dev|sources|javadoc)).jar
files-secondary: build/libs/*-@(dev|sources).jar files-secondary: build/libs/*-@(dev|sources|javadoc).jar
name: Sodium 0.3.2 for Minecraft 1.17.1 name: Sodium 0.3.2 for Minecraft 1.17.1
version: mc1.17.1-0.3.2 version: mc1.17.1-0.3.2
@ -109,8 +109,8 @@ jobs:
| [github-discussion](#user-content-github-discussion) | If specified, a discussion of the specified category is created and linked to the release. Unused if the GitHub Release already exists [🛈](https://docs.github.com/en/rest/releases/releases#create-a-release) | ❌ | `Announcements` | | [github-discussion](#user-content-github-discussion) | If specified, a discussion of the specified category is created and linked to the release. Unused if the GitHub Release already exists [🛈](https://docs.github.com/en/rest/releases/releases#create-a-release) | ❌ | `Announcements` |
| [github-token](#user-content-github-token) | A valid token for the GitHub API | ❌ | `${{ secrets.GITHUB_TOKEN }}` | | [github-token](#user-content-github-token) | A valid token for the GitHub API | ❌ | `${{ secrets.GITHUB_TOKEN }}` |
| [files](#user-content-files) | A [glob](https://www.digitalocean.com/community/tools/glob) of the file(s) to upload | ❌ | `build/libs/*.jar` | | [files](#user-content-files) | A [glob](https://www.digitalocean.com/community/tools/glob) of the file(s) to upload | ❌ | `build/libs/*.jar` |
| [files-primary](#user-content-files-primary) | A [glob](https://www.digitalocean.com/community/tools/glob) of the primary files to upload | `build/libs/!(*-@(dev\|sources)).jar` | `build/libs/!(*-@(dev\|sources)).jar` | | [files-primary](#user-content-files-primary) | A [glob](https://www.digitalocean.com/community/tools/glob) of the primary files to upload | `build/libs/!(*-@(dev\|sources\|javadoc)).jar` | `build/libs/!(*-@(dev\|sources\|javadoc)).jar` |
| [files-secondary](#user-content-files-secondary) | A [glob](https://www.digitalocean.com/community/tools/glob) of the secondary files to upload | `build/libs/*-@(dev\|sources).jar` | `build/libs/*-@(dev\|sources).jar` | | [files-secondary](#user-content-files-secondary) | A [glob](https://www.digitalocean.com/community/tools/glob) of the secondary files to upload | `build/libs/*-@(dev\|sources\|javadoc).jar` | `build/libs/*-@(dev\|sources\|javadoc).jar` |
| [name](#user-content-name) | The name of the version | A title of the release that triggered the action | `Sodium 0.3.2 for Minecraft 1.17.1` | | [name](#user-content-name) | The name of the version | A title of the release that triggered the action | `Sodium 0.3.2 for Minecraft 1.17.1` |
| [version](#user-content-version) | The version number | A tag of the release that triggered the action | `mc1.17.1-0.3.2` | | [version](#user-content-version) | The version number | A tag of the release that triggered the action | `mc1.17.1-0.3.2` |
| [version-type](#user-content-version-type) | The type of the release | Will be parsed from the [`version`](#user-content-version) value | `alpha` <br> `beta` <br> `release` | | [version-type](#user-content-version-type) | The type of the release | Will be parsed from the [`version`](#user-content-version) value | `alpha` <br> `beta` <br> `release` |
@ -129,14 +129,14 @@ Note, that you can use any top-level property *(`name`, `version`, `dependencies
```yaml ```yaml
# It is a good idea to share the same primary file among different targets # It is a good idea to share the same primary file among different targets
files-primary: build/libs/!(*-@(dev\|sources)).jar files-primary: build/libs/!(*-@(dev\|sources\|javadoc)).jar
modrinth-id: aaaAAAaa modrinth-id: aaaAAAaa
modrinth-token: ${{ secrets.MODRINTH_TOKEN }} modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
# Modrinth-specific name for your mod # Modrinth-specific name for your mod
modrinth-name: Modrinth Mod modrinth-name: Modrinth Mod
# Modrinth-specific secondary files # Modrinth-specific secondary files
modrinth-files-secondary: build/libs/*-@(dev\|sources).jar modrinth-files-secondary: build/libs/*-@(dev\|sources\|javadoc).jar
# Modrinth-specific dependencies # Modrinth-specific dependencies
# It is possible to use project ids instead of slugs # It is possible to use project ids instead of slugs
modrinth-dependencies: | modrinth-dependencies: |
@ -469,18 +469,18 @@ files: build/libs/*.jar
#### files-primary #### files-primary
A glob of the primary files to upload. Default value is `build/libs/!(*-@(dev|sources)).jar`. A glob of the primary files to upload. Default value is `build/libs/!(*-@(dev|sources|javadoc)).jar`.
```yaml ```yaml
files-primary: build/libs/!(*-@(dev|sources)).jar files-primary: build/libs/!(*-@(dev|sources|javadoc)).jar
``` ```
#### files-secondary #### files-secondary
A glob of the secondary files to upload. Default value is `build/libs/*-@(dev|sources).jar`. A glob of the secondary files to upload. Default value is `build/libs/*-@(dev|sources|javadocs).jar`.
```yaml ```yaml
files-secondary: build/libs/*-@(dev|sources).jar files-secondary: build/libs/*-@(dev|sources|javadoc).jar
``` ```
#### name #### name
@ -748,4 +748,4 @@ Available values:
- `fail` - immediately sets the action status to **failed** and terminates its execution - `fail` - immediately sets the action status to **failed** and terminates its execution
- `warn` - warns about errors. The action won't be terminated, nor its status will be set to **failed** - `warn` - warns about errors. The action won't be terminated, nor its status will be set to **failed**
- `skip` - warns about errors. The action won't be terminated, but its status will be set to **failed** after all specified targets have been processed - `skip` - warns about errors. The action won't be terminated, but its status will be set to **failed** after all specified targets have been processed

View file

@ -5,8 +5,8 @@ import glob from "fast-glob";
export type FileSelector = string | { primary?: string, secondary?: string }; export type FileSelector = string | { primary?: string, secondary?: string };
export const gradleOutputSelector = { export const gradleOutputSelector = {
primary: "build/libs/!(*-@(dev|sources)).jar", primary: "build/libs/!(*-@(dev|sources|javadoc)).jar",
secondary: "build/libs/*-@(dev|sources).jar" secondary: "build/libs/*-@(dev|sources|javadoc).jar"
}; };
export default class File { export default class File {