๐ Automatically update docs with new releases
Opened this issue ยท 0 comments
mikaeldui commented
Problem
The current docs at https://stelar7.no/l4j8/ are for version 1.7.3. They don't contain documentation for newer endpoints like match-v5 and contain documentation for endpoints that no longer can be called, like match-v4.
Solution
Generate and deploy documentation when there are new releases. This would preferably be done in some some automated fashion with pipelines like Travis or GitHub Actions.
Example
Using the GitHub Action sebastianpopp/ftp-action.
- name: Generate Docs
run: mvn javadoc:javadoc
- name: Upload Docs
uses: sebastianpopp/ftp-action@releases/v2
with:
host: ${{ secrets.FTP_SERVER }}
user: ${{ secrets.FTP_USERNAME }}
password: ${{ secrets.FTP_PASSWORD }}
localDir: "docs"
remoteDir: "www/l4j8"