-
-
Notifications
You must be signed in to change notification settings - Fork 373
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev/feature' into dev/feature
- Loading branch information
Showing
27 changed files
with
943 additions
and
226 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| name: Archive documentation | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| archive-docs: | ||
| if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')" | ||
| needs: release-docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Configure workflow | ||
| id: configuration | ||
| run: | | ||
| echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | ||
| echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT | ||
| echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT | ||
| echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT | ||
| - name: Checkout Skript | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| path: skript | ||
| - name: Setup documentation environment | ||
| uses: ./skript/.github/workflows/docs/setup-docs | ||
| with: | ||
| docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }} | ||
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | ||
| - name: Generate documentation | ||
| uses: ./skript/.github/workflows/docs/generate-docs | ||
| with: | ||
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | ||
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | ||
| skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }} | ||
| is_release: true | ||
| generate_javadocs: true | ||
| - name: Push archive documentation | ||
| uses: ./skript/.github/workflows/docs/push-docs | ||
| with: | ||
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | ||
| git_name: Archive Docs Bot | ||
| git_email: [email protected] | ||
| git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ name: Release documentation | |
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| release-docs: | ||
|
|
@@ -33,6 +34,7 @@ jobs: | |
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | ||
| skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }} | ||
| is_release: true | ||
| generate_javadocs: true | ||
| cleanup_pattern: "!(nightly|archives|templates)" | ||
| - name: Push release documentation | ||
| uses: ./skript/.github/workflows/docs/push-docs | ||
|
|
@@ -41,40 +43,3 @@ jobs: | |
| git_name: Release Docs Bot | ||
| git_email: [email protected] | ||
| git_commit_message: "Update release docs to ${{ steps.configuration.outputs.BRANCH_NAME }}" | ||
|
|
||
| archive-docs: | ||
| if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')" | ||
| needs: release-docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Configure workflow | ||
| id: configuration | ||
| run: | | ||
| echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | ||
| echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT | ||
| echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT | ||
| echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT | ||
| - name: Checkout Skript | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| path: skript | ||
| - name: Setup documentation environment | ||
| uses: ./skript/.github/workflows/docs/setup-docs | ||
| with: | ||
| docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }} | ||
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | ||
| - name: Generate documentation | ||
| uses: ./skript/.github/workflows/docs/generate-docs | ||
| with: | ||
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | ||
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | ||
| skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }} | ||
| is_release: true | ||
| - name: Push archive documentation | ||
| uses: ./skript/.github/workflows/docs/push-docs | ||
| with: | ||
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | ||
| git_name: Archive Docs Bot | ||
| git_email: [email protected] | ||
| git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
src/main/java/ch/njol/skript/classes/registry/RegistryClassInfo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /** | ||
| * This file is part of Skript. | ||
| * | ||
| * Skript is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * Skript is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with Skript. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| * Copyright Peter Güttinger, SkriptLang team and contributors | ||
| */ | ||
| package ch.njol.skript.classes.registry; | ||
|
|
||
| import ch.njol.skript.classes.ClassInfo; | ||
| import ch.njol.skript.expressions.base.EventValueExpression; | ||
| import ch.njol.skript.lang.DefaultExpression; | ||
| import org.bukkit.Keyed; | ||
| import org.bukkit.Registry; | ||
|
|
||
| /** | ||
| * This class can be used for easily creating ClassInfos for {@link Registry}s. | ||
| * It registers a language node with usage, a serializer, default expression, and a parser. | ||
| * | ||
| * @param <R> The Registry class. | ||
| */ | ||
| public class RegistryClassInfo<R extends Keyed> extends ClassInfo<R> { | ||
|
|
||
| public RegistryClassInfo(Class<R> registryClass, Registry<R> registry, String codeName, String languageNode) { | ||
| this(registryClass, registry, codeName, languageNode, new EventValueExpression<>(registryClass)); | ||
| } | ||
|
|
||
| /** | ||
| * @param registry The registry | ||
| * @param codeName The name used in patterns | ||
| */ | ||
| public RegistryClassInfo(Class<R> registryClass, Registry<R> registry, String codeName, String languageNode, DefaultExpression<R> defaultExpression) { | ||
| super(registryClass, codeName); | ||
| RegistryParser<R> registryParser = new RegistryParser<>(registry, languageNode); | ||
| usage(registryParser.getAllNames()) | ||
| .supplier(registry::iterator) | ||
| .serializer(new RegistrySerializer<R>(registry)) | ||
| .defaultExpression(defaultExpression) | ||
| .parser(registryParser); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.