From 45cf58941e77cf792e48f6fb03778903e40755bb Mon Sep 17 00:00:00 2001 From: Manoel Campos Date: Tue, 13 Feb 2018 17:40:49 -0300 Subject: [PATCH 1/4] Small updates in the README. --- .gitignore | 0 .travis.yml | 0 LICENSE | 0 NOTICE | 0 README.adoc | 6 +++--- pom.xml | 0 sample/pom.xml | 0 sample/src/main/java/people/Person.java | 0 sample/src/main/java/vehicles/AbstractVehicle.java | 0 sample/src/main/java/vehicles/Car.java | 0 sample/src/main/java/vehicles/Vehicle.java | 0 src/main/java/org/asciidoctor/ExportDoclet.java | 4 ++-- src/main/java/org/asciidoctor/ExportRenderer.java | 0 src/main/java/org/asciidoctor/StandardAdapter.java | 0 src/main/java/org/asciidoctor/package-info.java | 0 15 files changed, 5 insertions(+), 5 deletions(-) mode change 100644 => 100755 .gitignore mode change 100644 => 100755 .travis.yml mode change 100644 => 100755 LICENSE mode change 100644 => 100755 NOTICE mode change 100644 => 100755 README.adoc mode change 100644 => 100755 pom.xml mode change 100644 => 100755 sample/pom.xml mode change 100644 => 100755 sample/src/main/java/people/Person.java mode change 100644 => 100755 sample/src/main/java/vehicles/AbstractVehicle.java mode change 100644 => 100755 sample/src/main/java/vehicles/Car.java mode change 100644 => 100755 sample/src/main/java/vehicles/Vehicle.java mode change 100644 => 100755 src/main/java/org/asciidoctor/ExportDoclet.java mode change 100644 => 100755 src/main/java/org/asciidoctor/ExportRenderer.java mode change 100644 => 100755 src/main/java/org/asciidoctor/StandardAdapter.java mode change 100644 => 100755 src/main/java/org/asciidoctor/package-info.java diff --git a/.gitignore b/.gitignore old mode 100644 new mode 100755 diff --git a/.travis.yml b/.travis.yml old mode 100644 new mode 100755 diff --git a/LICENSE b/LICENSE old mode 100644 new mode 100755 diff --git a/NOTICE b/NOTICE old mode 100644 new mode 100755 diff --git a/README.adoc b/README.adoc old mode 100644 new mode 100755 index 026192d..04be734 --- a/README.adoc +++ b/README.adoc @@ -3,7 +3,7 @@ image:https://travis-ci.org/johncarl81/exportdoclet.svg?branch=master["Build Status", link="https://travis-ci.org/johncarl81/exportdoclet"] A link:http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/doclet/overview.html[Doclet] that allows exporting javadoc -comments containing link:http://asciidoctor.org[AsciiDoc] text to AsciiDoc files, enabling combining the javadocs into a broader AsciiDoc documentation for your Java project. +comments containing link:http://asciidoctor.org[AsciiDoc] markup to AsciiDoc files, enabling combining the javadocs into a broader AsciiDoc documentation for your Java project. Instead of exporting the javadoc comments to standard HTML files, the ExportDoclet exports them to AsciiDoc files, that in turn can be converted to any output format supported by the link:http://asciidoctor.org[AsciiDoctor toolchain]. @@ -15,12 +15,12 @@ ExportDoclet encourages developers to write meaninguful and expanded documentati == Building the ExportDoclet -ExportDoclet is a Java Maven project that can be built directly from any IDE or using the following maven command: +ExportDoclet is a Java Maven project which can be built directly from any IDE or using the following maven command: [source,bash] mvn clean install -That will build the tool and install it at your local maven repository, usually at the .m2 directory +That will build the tool and install it at your local maven repository, usually at the `.m2` directory inside your home directory. == How to use ExportDoclet diff --git a/pom.xml b/pom.xml old mode 100644 new mode 100755 diff --git a/sample/pom.xml b/sample/pom.xml old mode 100644 new mode 100755 diff --git a/sample/src/main/java/people/Person.java b/sample/src/main/java/people/Person.java old mode 100644 new mode 100755 diff --git a/sample/src/main/java/vehicles/AbstractVehicle.java b/sample/src/main/java/vehicles/AbstractVehicle.java old mode 100644 new mode 100755 diff --git a/sample/src/main/java/vehicles/Car.java b/sample/src/main/java/vehicles/Car.java old mode 100644 new mode 100755 diff --git a/sample/src/main/java/vehicles/Vehicle.java b/sample/src/main/java/vehicles/Vehicle.java old mode 100644 new mode 100755 diff --git a/src/main/java/org/asciidoctor/ExportDoclet.java b/src/main/java/org/asciidoctor/ExportDoclet.java old mode 100644 new mode 100755 index 7f3a226..8984e19 --- a/src/main/java/org/asciidoctor/ExportDoclet.java +++ b/src/main/java/org/asciidoctor/ExportDoclet.java @@ -35,7 +35,7 @@ public class ExportDoclet extends Doclet { * Starts the doclet. * @param rootDoc the root of the program structure information. * From this root all other program structure information can be extracted. - * @return true if the doclet was started successfuly, false otherwise + * @return true if the doclet was started successfully, false otherwise * @see Doclet#start(RootDoc) */ @SuppressWarnings("UnusedDeclaration") @@ -96,4 +96,4 @@ public static LanguageVersion languageVersion() { private boolean render(){ return renderer.render(); } -} +} \ No newline at end of file diff --git a/src/main/java/org/asciidoctor/ExportRenderer.java b/src/main/java/org/asciidoctor/ExportRenderer.java old mode 100644 new mode 100755 diff --git a/src/main/java/org/asciidoctor/StandardAdapter.java b/src/main/java/org/asciidoctor/StandardAdapter.java old mode 100644 new mode 100755 diff --git a/src/main/java/org/asciidoctor/package-info.java b/src/main/java/org/asciidoctor/package-info.java old mode 100644 new mode 100755 From a49d32064beea770812c24916851c8d86ac7c97e Mon Sep 17 00:00:00 2001 From: snyk-bot Date: Fri, 4 Jan 2019 02:16:41 +0000 Subject: [PATCH 2/4] fix: pom.xml to reduce vulnerabilities The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JAVA-COMGOOGLEGUAVA-32236 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) mode change 100755 => 100644 pom.xml diff --git a/pom.xml b/pom.xml old mode 100755 new mode 100644 index b122751..1e76435 --- a/pom.xml +++ b/pom.xml @@ -61,7 +61,7 @@ com.google.guava guava - 17.0 + 24.1.1-jre junit From b835148397502ac3283379e03702eaa3c1bda6dd Mon Sep 17 00:00:00 2001 From: Manoel Campos da Silva Filho Date: Mon, 17 Aug 2020 11:18:56 -0300 Subject: [PATCH 3/4] Create asciidoctor-ghpages.yml Uses the Asciidoctor GhPages Action to automatically build the README.adoc (and any other adoc file) to HTML, pushing to the gh-pages branch to enable GitHub Pages for the project. --- .github/workflows/asciidoctor-ghpages.yml | 26 +++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/asciidoctor-ghpages.yml diff --git a/.github/workflows/asciidoctor-ghpages.yml b/.github/workflows/asciidoctor-ghpages.yml new file mode 100644 index 0000000..8dc070c --- /dev/null +++ b/.github/workflows/asciidoctor-ghpages.yml @@ -0,0 +1,26 @@ +name: asciidoctor-ghpages + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: asciidoctor-ghpages + uses: manoelcampos/asciidoctor-ghpages-action@v1.1.0 + with: + asciidoctor_params: --attribute=nofooter From 7bca7ac92e51b486796d37706fca51f5d2c023de Mon Sep 17 00:00:00 2001 From: snyk-test Date: Mon, 24 Jun 2019 05:36:32 +0000 Subject: [PATCH 4/4] fix: pom.xml to reduce vulnerabilities The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JAVA-COMGOOGLEGUAVA-32236 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1e76435..52ac191 100644 --- a/pom.xml +++ b/pom.xml @@ -61,7 +61,7 @@ com.google.guava guava - 24.1.1-jre + 26.0-jre junit