Skip to content

Commit

Permalink
enh: add workflow to publish javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayankur31 committed Mar 10, 2021
1 parent a3b58a6 commit 8aead37
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 0 deletions.
116 changes: 116 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Publish Javadocs

on:
push:
branches: [ development ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: nelonoel/[email protected]

- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
java-package: jdk

- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.9

- name: Install GH import
run: |
python -m pip install --upgrade pip
pip install ghp-import
- name: Checkout NeuroML2
uses: actions/checkout@v2
with:
repository: NeuroML/NeuroML2
ref: development
path: NeuroML2

- name: Checkout org.lemsml
uses: actions/checkout@v2
with:
repository: LEMS/jLEMS
ref: development
path: jLEMS

- name: Checkout org.neuroml.model.injectingplugin
uses: actions/checkout@v2
with:
repository: NeuroML/org.neuroml.model.injectingplugin
ref: development
path: org.neuroml.model.injectingplugin

- name: Checkout org.neuroml1.model
uses: actions/checkout@v2
with:
repository: NeuroML/org.neuroml1.model
ref: development
path: org.neuroml1.model

- name: Checkout org.neuroml.model
uses: actions/checkout@v2
with:
repository: NeuroML/org.neuroml.model
ref: development
path: org.neuroml.model

- name: Checkout org.neuroml.export
uses: actions/checkout@v2
with:
repository: NeuroML/org.neuroml.export
ref: development
path: org.neuroml.export

- name: Checkout org.neuroml.import
uses: actions/checkout@v2
with:
repository: NeuroML/org.neuroml.import
ref: development
path: org.neuroml.import


- name: Install NeuroML deps
run: |
pushd jLEMS
mvn install
popd
pushd NeuroML2
mvn install
popd
pushd org.neuroml.model.injectingplugin
mvn install
popd
pushd org.neuroml1.model
mvn install
popd
pushd org.neuroml.model
mvn install
popd
pushd org.neuroml.export
mvn install
popd
pushd org.neuroml.import
mvn install
popd
- name: Build docs
run: |
mvn javadoc:javadoc
- name: Publish documentation on GH pages
run: |
ghp-import -f -m "Regenerate documentation" -b gh-pages -n -p target/site/apidocs
14 changes: 14 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<source>8</source>
<top>
&lt;br /&gt;&emsp;Learn more about NeuroML at &lt;a href=&quot;http://neuroml.org&quot; target=&quot;_blank&quot;&gt;NeuroML.org&lt;/a&gt;
&lt;br /&gt;
&lt;br /&gt;
</top>
<bottom>Copyright NeuroML Contributors 2021</bottom>
</configuration>
</plugin>
<plugin>
<!-- NOTE: We don't need a groupId specification because
the group is org.apache.maven.plugins ...which is assumed by default. -->
Expand Down

0 comments on commit 8aead37

Please sign in to comment.