Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish generated docs as part of release build #471

Closed
DirkMahler opened this issue Jul 12, 2024 · 2 comments · Fixed by #519 or jqassistant-tooling/jqassistant-github-actions#15
Closed
Assignees
Labels
Milestone

Comments

@DirkMahler
Copy link
Member

DirkMahler commented Jul 12, 2024

The Maven build creates a zip file containing the manual which is committed to the gh-pages branch as a manual step.

It needs to be clarified if we want to keep the GH pages approach, in this case the upload should happen automatically during a release build.

Another option would be that the docs are just adoc files beside the source code that are rendered by GitHub. In this case we need to define how to deal with generated docs (i.e. plugin rules)

@DirkMahler
Copy link
Member Author

DirkMahler commented Jul 22, 2024

If possible there should be different paths used in the URL for CI and release workflow, resulting in the following URLs:

Release:

  • https://jqassistant.github.io/jqassistant/
  • e.g. https://jqassistant.github.io/jqassistant/2.4.0
  • additionally for a stable URL on the latest release version https://jqassistant.github.io/jqassistant/current should be available which is only deployed if activated for the release build (input: deployCurrentDoc)

CI:

yaseno2186 added a commit that referenced this issue Jul 23, 2024
Adjusted default file input path
@yaseno2186
Copy link
Contributor

last commit is wrong , does nothing with this ticket

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment