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

Setup the website publishing pipeline #3199

Merged

Conversation

cortinico
Copy link
Member

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 the docs/ folder of the master 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).

@codecov
Copy link

codecov bot commented Nov 4, 2020

Codecov Report

Merging #3199 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update edaa3e9...fd8087d. Read the comment docs.

with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: docs/_site/
Copy link
Member

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?

Copy link
Member Author

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 :|).

@cortinico
Copy link
Member Author

Forgot to mention that a successful publishing is available on my fork:
http://ncorti.com/detekt/

Here a CI run:
https://github.com/cortinico/detekt/actions/runs/345333123

@arturbosch
Copy link
Member

@cortinico looks good to me, thanks for the work! 👍
please rebase the branch a last time, I will change the pages branch before merging this then.

@arturbosch arturbosch added the housekeeping Marker for housekeeping tasks and refactorings label Nov 5, 2020
@arturbosch arturbosch added this to the 1.15.0 milestone Nov 5, 2020
@cortinico cortinico force-pushed the nc/3160/docs-publishing-pipeline branch from 40f32fc to fd8087d Compare November 5, 2020 19:28
@cortinico
Copy link
Member Author

cortinico commented Nov 5, 2020

Let's keep an eye the files inside docs/pages/kdoc and docs/pages/documentation are not added again by mistake.

@arturbosch arturbosch merged commit 7f8ee20 into detekt:master Nov 6, 2020
@arturbosch
Copy link
Member

It's up and works! 👍

@cortinico cortinico deleted the nc/3160/docs-publishing-pipeline branch November 6, 2020 12:38
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this pull request Nov 8, 2020
* 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
arturbosch pushed a commit that referenced this pull request Nov 15, 2020
* 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
arturbosch pushed a commit that referenced this pull request Dec 21, 2020
* 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
arturbosch pushed a commit that referenced this pull request Jan 16, 2021
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants