Code Monkey home page Code Monkey logo

Comments (16)

i-make-robots avatar i-make-robots commented on September 24, 2024 1 
Run actions/jekyll-build-pages@v1
/usr/bin/docker run --name ghcrioactionsjekyllbuildpagesv109_1bd5e3 --label 4a9bca --workdir /github/workspace --rm -e "INPUT_SOURCE" -e "INPUT_DESTINATION" -e "INPUT_FUTURE" -e "INPUT_BUILD_REVISION" -e "INPUT_VERBOSE" -e "INPUT_TOKEN" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENVIRONMENT" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e "ACTIONS_ID_TOKEN_REQUEST_URL" -e "ACTIONS_ID_TOKEN_REQUEST_TOKEN" -e "ACTIONS_RESULTS_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/Robot-Overlord-App/Robot-Overlord-App":"/github/workspace" ghcr.io/actions/jekyll-build-pages:v1.0.9
Configuration file: none
To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
  Logging at level: debug
      GitHub Pages: github-pages v228
      GitHub Pages: jekyll v3.9.3
             Theme: jekyll-theme-primer
      Theme source: /usr/local/bundle/gems/jekyll-theme-primer-0.6.0
         Requiring: jekyll-github-metadata
         Requiring: jekyll-seo-tag
         Requiring: jekyll-coffeescript
         Requiring: jekyll-commonmark-ghpages
         Requiring: jekyll-gist
         Requiring: jekyll-github-metadata
         Requiring: jekyll-paginate
         Requiring: jekyll-relative-links
         Requiring: jekyll-optional-front-matter
         Requiring: jekyll-readme-index
         Requiring: jekyll-default-layout
         Requiring: jekyll-titles-from-headings
   GitHub Metadata: Initializing...
            Source: /github/workspace/./docs
       Destination: /github/workspace/./docs/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
        Generating: JekyllOptionalFrontMatter::Generator finished in 0.000117911 seconds.
        Generating: JekyllReadmeIndex::Generator finished in 0.001352586 seconds.
        Generating: Jekyll::Paginate::Pagination finished in 2.895e-06 seconds.
        Generating: JekyllRelativeLinks::Generator finished in 1.9866e-05 seconds.
        Generating: JekyllDefaultLayout::Generator finished in 0.000242403 seconds.
         Requiring: kramdown-parser-gfm
        Generating: JekyllTitlesFromHeadings::Generator finished in 0.007709659 seconds.
         Rendering: assets/css/style.scss
  Pre-Render Hooks: assets/css/style.scss
  Rendering Markup: assets/css/style.scss
         Rendering: README.md
  Pre-Render Hooks: README.md
  Rendering Markup: README.md
  Rendering Layout: README.md
     Layout source: theme
   GitHub Metadata: Generating for MarginallyClever/Robot-Overlord-App
   GitHub Metadata: Calling @client.repository("MarginallyClever/Robot-Overlord-App", {:accept=>"application/vnd.github.drax-preview+json"})
   GitHub Metadata: Calling @client.pages("MarginallyClever/Robot-Overlord-App", {})
           Writing: /github/workspace/docs/_site/assets/css/style.css
           Writing: /github/workspace/docs/_site/index.html
                    done in 1.596 seconds.
 Auto-regeneration: disabled. Use --watch to enable.```

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024 1

I have updated my code to fix all the HTML errors in the comments. The results are the same. I'm sure the problem is sitting in my chair. When I run javadoc locally I get only three packages and the most important ones are missing. Any hint?

Please only try to build the javadoc branch. Thanks!

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024 1

javadoc can only see the module components that are declared "opens".
I opened my entire module for javadoc to document my classes: the first line of my module-info.java now reads "open module..."
DoH!

from javadoc-publisher.yml.

MathieuSoysal avatar MathieuSoysal commented on September 24, 2024

Thank you for your issue ! :D

I have checked your project and I have got this error to generate the JavaDoc:

Error:  /home/runner/work/Robot-Overlord-App/Robot-Overlord-App/src/main/java/com/marginallyclever/robotoverlord/SerializationContext.java:4: error: reference not found
Error:   * Used by {@link com.marginallyclever.robotoverlord.components} to translate between relative

https://github.com/MathieuSoysal/Robot-Overlord-App/actions/runs/7426918142/job/20211600927

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

I'm getting tired and going too fast. Opening the module only fixed my local copy.

from javadoc-publisher.yml.

MathieuSoysal avatar MathieuSoysal commented on September 24, 2024

In fact the problem is from this line:

Javadoc-publisher.yml/action.yml

Line 33 in 02c11e2

default: "adopt"

The adopt java distribution is not anymore supported, and we need to change the default java distribution to another.

Source:

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024 
Run actions/jekyll-build-pages@v1
/usr/bin/docker run --name ghcrioactionsjekyllbuildpagesv109_c41f68 --label 94a281 --workdir /github/workspace --rm -e "INPUT_SOURCE" -e "INPUT_DESTINATION" -e "INPUT_FUTURE" -e "INPUT_BUILD_REVISION" -e "INPUT_VERBOSE" -e "INPUT_TOKEN" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENVIRONMENT" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e "ACTIONS_ID_TOKEN_REQUEST_URL" -e "ACTIONS_ID_TOKEN_REQUEST_TOKEN" -e "ACTIONS_RESULTS_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/Robot-Overlord-App/Robot-Overlord-App":"/github/workspace" ghcr.io/actions/jekyll-build-pages:v1.0.9
Configuration file: none
To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
  Logging at level: debug
      GitHub Pages: github-pages v228
      GitHub Pages: jekyll v3.9.3
             Theme: jekyll-theme-primer
      Theme source: /usr/local/bundle/gems/jekyll-theme-primer-0.6.0
         Requiring: jekyll-github-metadata
         Requiring: jekyll-seo-tag
         Requiring: jekyll-coffeescript
         Requiring: jekyll-commonmark-ghpages
         Requiring: jekyll-gist
         Requiring: jekyll-github-metadata
         Requiring: jekyll-paginate
         Requiring: jekyll-relative-links
         Requiring: jekyll-optional-front-matter
         Requiring: jekyll-readme-index
         Requiring: jekyll-default-layout
         Requiring: jekyll-titles-from-headings
   GitHub Metadata: Initializing...
            Source: /github/workspace/./docs
       Destination: /github/workspace/./docs/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
        Generating: JekyllOptionalFrontMatter::Generator finished in 7.394e-06 seconds.
        Generating: JekyllReadmeIndex::Generator finished in 4.589e-06 seconds.
        Generating: Jekyll::Paginate::Pagination finished in 2.445e-06 seconds.
        Generating: JekyllRelativeLinks::Generator finished in 2.0358e-05 seconds.
        Generating: JekyllDefaultLayout::Generator finished in 8.777e-06 seconds.
        Generating: JekyllTitlesFromHeadings::Generator finished in 5.71e-06 seconds.
         Rendering: assets/css/style.scss
  Pre-Render Hooks: assets/css/style.scss
  Rendering Markup: assets/css/style.scss
           Writing: /github/workspace/docs/_site/assets/css/style.css
                    done in 0.987 seconds.
 Auto-regeneration: disabled. Use --watch to enable.

I replaced ./docs/README.md with ./docs/.placeholder so the folder would still exist. it's rendering nothing :T

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

Any more ideas what's missing? I'm so so sorry for being too stupid to solve this myself...

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024 
Source: /github/workspace/./docs
Destination: /github/workspace/./docs/_site

Uh... pardon my ignorance... would it work better if the source was my source folder, instead of the empty docs folder?

from javadoc-publisher.yml.

MathieuSoysal avatar MathieuSoysal commented on September 24, 2024

I saw that it works now congret 🥳

https://marginallyclever.github.io/Robot-Overlord-App/

from javadoc-publisher.yml.

MathieuSoysal avatar MathieuSoysal commented on September 24, 2024

In fact the problem is from this line:

Javadoc-publisher.yml/action.yml

Line 33 in 02c11e2

default: "adopt"

The adopt java distribution is not anymore supported, and we need to change the default java distribution to another.

Source:

* https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#adopt

* https://blog.adoptopenjdk.net/2021/08/goodbye-adoptopenjdk-hello-adoptium/

@i-make-robots

You can contribute to our project if you want :D

We need to change this line:

Javadoc-publisher.yml/action.yml

Line 33 in 02c11e2

default: "adopt"

instead of adopt we need to write temurin

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

Uh... that it published is news to me. I wasn't aware it had passed.

I think what I did was locally generate javadoc and put it in the docs folder, then jekyll was able to find and publish it... which is not what I expected at all. I thought the plugin would both generate AND publish the javadoc. Is my expectation wrong? Could the README manage expectations bebtter? More "how this is intended for use"?

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

Added the "clean" flag per your PR,

Unexpected input(s) 'clean', valid inputs are ['java-version', 'GITHUB_TOKEN', 'javadoc-branch', 'target-folder', 'java-distribution', 'project', 'custom-command', 'subdirectories', 'without-deploy', 'without-checkout']

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

I am able to publish from my javadoc branch, which is good and thank you for your awesome help.
I get the message

The directory you're trying to deploy named /home/runner/work/Robot-Overlord-App/Robot-Overlord-App/target/site/apidocs doesn't exist. Please double check the path and any prerequisite build scripts and try again. ❗

Because of my pom I do not generate code that goes to ./target/site/apidocs. Instead it goes to ./docs. It would seem the Action does not understand the pom config and incorrectly reports a failure.

from javadoc-publisher.yml.

i-make-robots avatar i-make-robots commented on September 24, 2024

Also I am manually building javadoc on the javadoc branch, it still doesn't want to build my docs automatically. Whatever, I can live with it... but it's not as buttery smooth as I dream it could be.

from javadoc-publisher.yml.

MathieuSoysal avatar MathieuSoysal commented on September 24, 2024

I have some questions:

  • Why did you put "javadoc" here why you didn't put master instead of javadoc ?
    Because when you write javadoc on the line 6, the github action build your docs only when you push to javadoc branch, is not better when you built javadoc when you push to master ?

If your javadoc doesn't go to ./target/site/apidocs you need to add a line:

          javadoc-source-folder: docs

Final result of yaml:

name: Deploy Javadoc

on:
  push:
    branches:
      - master

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: Deploy JavaDoc 🚀
        uses: MathieuSoysal/[email protected]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          java-version: 17
          javadoc-branch: javadoc
          java-distribution: temurin
          project: maven
          javadoc-source-folder: docs
          # url will be https://<username>.github.io/<repo>/<target-folder>.
          # update this to the project version number
          target-folder: 3.0

from javadoc-publisher.yml.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.