wanjia9506
/
langchain4j
mirror of https://github.com/langchain4j/langchain4j.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
langchain4j/.github/workflows/docs.yaml

55 lines
1.3 KiB
YAML
Raw Permalink Normal View History

Updated Docs (#500) - Updated subpage 0 to `Overview` and made it the landing page upon clicking `Tutorials` from the horizontal/navigation/top bar. - Set up GitHub action to build and publish the docs to the GitHub pages on release. [Preview](https://amithkoujalgi.github.io/langchain4j/) of the docs on GitHub pages. This action/workflow can also be triggered manually. - Added content to `/integrations/language-models/ollama` PS: If GitHub pages has been enabled in the repository, the repo admin should be able to run the new GitHub workflow/action in the Actions tab and after the completion of the workflow, the docs should be available in the link provided by GitHub (or a specified custom domain).
2024-01-11 16:04:38 +08:00
name: Build and Publish Docs to GitHub Pages
on:
release:
types:
- created
# Allow running this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
packages: write
jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
Docs updates (#599) - Updated docs GH workflow to build and publish javadoc alongside of docs directory. This would make the docs available at https://langchain4j.github.io/langchain4j and javadoc at https://langchain4j.github.io/langchain4j/apidocs/index.html - Updated javadoc build command in docs GH workflow to do a full project build (that includes all modules and no exclusions). - Updated javadoc build in docs GH workflow to run with Java 21 version. This is in reference to https://github.com/langchain4j/langchain4j/discussions/596 --------- Co-authored-by: Lize Raes <49833622+LizeRaes@users.noreply.github.com>
2024-02-06 18:13:41 +08:00
- name: Set up JDK 21
uses: actions/setup-java@v3
with:
java-version: '21'
distribution: 'temurin'
cache: 'maven'
- name: Generate Javadoc
run: mvn javadoc:aggregate -DskipTests
- name: Set up Node.js
Updated Docs (#500) - Updated subpage 0 to `Overview` and made it the landing page upon clicking `Tutorials` from the horizontal/navigation/top bar. - Set up GitHub action to build and publish the docs to the GitHub pages on release. [Preview](https://amithkoujalgi.github.io/langchain4j/) of the docs on GitHub pages. This action/workflow can also be triggered manually. - Added content to `/integrations/language-models/ollama` PS: If GitHub pages has been enabled in the repository, the repo admin should be able to run the new GitHub workflow/action in the Actions tab and after the completion of the workflow, the docs should be available in the link provided by GitHub (or a specified custom domain).
2024-01-11 16:04:38 +08:00
uses: actions/setup-node@v3
with:
node-version: '20.x'
Docs updates (#599) - Updated docs GH workflow to build and publish javadoc alongside of docs directory. This would make the docs available at https://langchain4j.github.io/langchain4j and javadoc at https://langchain4j.github.io/langchain4j/apidocs/index.html - Updated javadoc build command in docs GH workflow to do a full project build (that includes all modules and no exclusions). - Updated javadoc build in docs GH workflow to run with Java 21 version. This is in reference to https://github.com/langchain4j/langchain4j/discussions/596 --------- Co-authored-by: Lize Raes <49833622+LizeRaes@users.noreply.github.com>
2024-02-06 18:13:41 +08:00
Updated Docs (#500) - Updated subpage 0 to `Overview` and made it the landing page upon clicking `Tutorials` from the horizontal/navigation/top bar. - Set up GitHub action to build and publish the docs to the GitHub pages on release. [Preview](https://amithkoujalgi.github.io/langchain4j/) of the docs on GitHub pages. This action/workflow can also be triggered manually. - Added content to `/integrations/language-models/ollama` PS: If GitHub pages has been enabled in the repository, the repo admin should be able to run the new GitHub workflow/action in the Actions tab and after the completion of the workflow, the docs should be available in the link provided by GitHub (or a specified custom domain).
2024-01-11 16:04:38 +08:00
- run: cd docs && npm ci
- run: cd docs && npm run build
Docs updates (#599) - Updated docs GH workflow to build and publish javadoc alongside of docs directory. This would make the docs available at https://langchain4j.github.io/langchain4j and javadoc at https://langchain4j.github.io/langchain4j/apidocs/index.html - Updated javadoc build command in docs GH workflow to do a full project build (that includes all modules and no exclusions). - Updated javadoc build in docs GH workflow to run with Java 21 version. This is in reference to https://github.com/langchain4j/langchain4j/discussions/596 --------- Co-authored-by: Lize Raes <49833622+LizeRaes@users.noreply.github.com>
2024-02-06 18:13:41 +08:00
- run: cp -R target/site/apidocs docs/build/
Updated Docs (#500) - Updated subpage 0 to `Overview` and made it the landing page upon clicking `Tutorials` from the horizontal/navigation/top bar. - Set up GitHub action to build and publish the docs to the GitHub pages on release. [Preview](https://amithkoujalgi.github.io/langchain4j/) of the docs on GitHub pages. This action/workflow can also be triggered manually. - Added content to `/integrations/language-models/ollama` PS: If GitHub pages has been enabled in the repository, the repo admin should be able to run the new GitHub workflow/action in the Actions tab and after the completion of the workflow, the docs should be available in the link provided by GitHub (or a specified custom domain).
2024-01-11 16:04:38 +08:00
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: './docs/build/.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2