docs: Publish javadocs to GH pages (#1824)

* docs: Publish javadocs to GH pages

* chore: Use up to date URLs

* chore: Update README url
This commit is contained in:
Alexander Brandes 2022-06-17 15:09:32 +02:00 committed by GitHub
parent fd00635533
commit 5b72f396bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 27 additions and 42 deletions

View File

@ -41,6 +41,30 @@ jobs:
env:
ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USERNAME }}
ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
- name: Publish core javadoc
if: ${{ runner.os == 'Linux' && env.STATUS == 'release' && github.event_name == 'push' && github.ref == 'refs/heads/main'}}
uses: cpina/github-action-push-to-another-repository@main
env:
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
with:
source-directory: 'worldedit-core/build/docs/javadoc'
destination-github-username: 'IntellectualSites'
destination-repository-name: 'fastasyncworldedit-javadocs'
user-email: ${{ secrets.USER_EMAIL }}
target-branch: main
target-directory: worldedit-core
- name: Publish bukkit javadoc
if: ${{ runner.os == 'Linux' && env.STATUS == 'release' && github.event_name == 'push' && github.ref == 'refs/heads/main'}}
uses: cpina/github-action-push-to-another-repository@main
env:
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
with:
source-directory: 'worldedit-bukkit/build/docs/javadoc'
destination-github-username: 'IntellectualSites'
destination-repository-name: 'fastasyncworldedit-javadocs'
user-email: ${{ secrets.USER_EMAIL }}
target-branch: main
target-directory: worldedit-bukkit
- name: Archive Artifacts
uses: actions/upload-artifact@v3
with:

View File

@ -1,37 +0,0 @@
name: "CodeQL"
on:
push:
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'java' ]
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
- name: Autobuild
uses: github/codeql-action/autobuild@v1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

View File

@ -22,9 +22,8 @@ Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot and
* link:https://discord.gg/intellectualsites[Discord]
* link:https://intellectualsites.github.io/fastasyncworldedit-documentation/[Wiki]
* link:https://github.com/IntellectualSites/FastAsyncWorldEdit/issues[Report Issue]
* link:https://intellectualsites.github.io/fastasyncworldedit-javadocs/[Javadocs]
* link:https://intellectualsites.crowdin.com/fastasyncworldedit[Crowdin (Translations)]
* link:https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Bukkit/latest/index.html[JavaDocs for the -bukkit module]
* link:https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Core/latest/index.html[JavaDocs for the -core module]
=== Edit The Code

View File

@ -59,14 +59,13 @@ fun Project.applyCommonJavaConfiguration(sourcesJar: Boolean, banSlf4j: Boolean
)
options.encoding = "UTF-8"
links(
"https://javadoc.io/doc/com.google.code.findbugs/jsr305/latest/index.html",
"https://jd.adventure.kyori.net/api/latest/",
"https://javadoc.io/doc/org.apache.logging.log4j/log4j-api/latest/index.html",
"https://logging.apache.org/log4j/2.x/log4j-api/apidocs/",
"https://www.antlr.org/api/Java/",
"https://docs.enginehub.org/javadoc/org.enginehub.piston/core/0.5.7/",
"https://docs.enginehub.org/javadoc/org.enginehub.piston/default-impl/0.5.7/",
"https://jd.papermc.io/paper/1.18/",
"https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Core" // needed for other module linking
"https://intellectualsites.github.io/fastasyncworldedit-javadocs/worldedit-core/"
)
}
}