-
-
Notifications
You must be signed in to change notification settings - Fork 773
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
Setup the website publishing pipeline #3199
Setup the website publishing pipeline #3199
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3199 +/- ##
=========================================
Coverage 80.07% 80.07%
Complexity 2638 2638
=========================================
Files 440 440
Lines 8019 8019
Branches 1540 1540
=========================================
Hits 6421 6421
Misses 775 775
Partials 823 823 Continue to review full report at Codecov.
|
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BRANCH: gh-pages | ||
FOLDER: docs/_site/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just curiosity: Why do you have two different tasks instead of just one? Can't you have sync problems?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you have two different tasks instead of just one?
Becuase the second one is running inside the jekyll/builder
container (as there we do already have Jekyll and Ruby and we just need to install the missing gems). Running Gradle tasks inside that container is a pain as all the Java tooling is missing (and the actions/setup-java
step was failing :|).
Forgot to mention that a successful publishing is available on my fork: Here a CI run: |
@cortinico looks good to me, thanks for the work! 👍 |
40f32fc
to
fd8087d
Compare
Let's keep an eye the files inside |
It's up and works! 👍 |
* Setup a website publishing pipeline * Revert Url back to https://detekt.github.io/detekt/ * Deploy only on master * Remove extra blank line * Update Java in pipeline to 11 * Remove remaining documentation page
* Setup a website publishing pipeline * Revert Url back to https://detekt.github.io/detekt/ * Deploy only on master * Remove extra blank line * Update Java in pipeline to 11 * Remove remaining documentation page
* Setup a website publishing pipeline * Revert Url back to https://detekt.github.io/detekt/ * Deploy only on master * Remove extra blank line * Update Java in pipeline to 11 * Remove remaining documentation page
* Setup a website publishing pipeline * Revert Url back to https://detekt.github.io/detekt/ * Deploy only on master * Remove extra blank line * Update Java in pipeline to 11 * Remove remaining documentation page
This PR sets up a workflow for building the KDoc/Documentation and the website and publish it to Github Pages. I've also removed all the generated files that were creating a lot of noise in the history (see #3160).
The generated website will be published on the
gh-pages
branch as a commit created by GH Actions.@arturbosch If we decide to merge this PR, you should update the GH Pages settings of the repo to publish from the
gh-pages
branch (I believe now is set to publish from thedocs/
folder of themaster
branch).I've also updated the
verify-documentation
job of the pre merge workflow to verify only the Generated Detekt Config file (as it's pointless now to verify the generated documentation).