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

Add workflow to publish Dokka HTML docs to project site #383

Merged
merged 8 commits into from
Jan 11, 2024

Conversation

EdricChan03
Copy link
Contributor

@EdricChan03 EdricChan03 commented Dec 22, 2023

Fixes #382

Demo: https://edricchan03.github.io/kotlin-logging/api/ (workflow run)

Note: You'll have to change the GitHub Pages source to use GitHub Actions instead, see the help docs on configuring a publishing source for more info

I've also noticed that there's a really old "docs" folder that doesn't seem to be used - should this be removed as well?

(Also, let me know if I should squash the 8 commits together on my end)

@oshai
Copy link
Owner

oshai commented Dec 25, 2023

Nice! Thanks for the details!

I've also noticed that there's a really old "docs" folder that doesn't seem to be used - should this be removed as well?

I think so.

(Also, let me know if I should squash the 8 commits together on my end)

I can do that on submit.

@oshai oshai merged commit b79c559 into oshai:master Jan 11, 2024
4 of 5 checks passed
@oshai
Copy link
Owner

oshai commented Jan 11, 2024

Thanks!

StefanLobbenmeier referenced this pull request in StefanLobbenmeier/yt-dlp-compose Jan 21, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[io.github.oshai:kotlin-logging-jvm](https://github.com/oshai/kotlin-logging)
| `5.1.1` -> `6.0.3` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.oshai:kotlin-logging-jvm/5.1.1/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.oshai:kotlin-logging-jvm/5.1.1/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>oshai/kotlin-logging
(io.github.oshai:kotlin-logging-jvm)</summary>

###
[`v6.0.3`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.3)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.2...6.0.3)

#### What's Changed

- Add Kotlin/Wasm (JS browser) support by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/388](https://github.com/oshai/kotlin-logging/pull/388)
- Bump com.diffplug.spotless from 6.23.3 to 6.24.0 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/390](https://github.com/oshai/kotlin-logging/pull/390)
- Bump actions/upload-pages-artifact from 2 to 3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/391](https://github.com/oshai/kotlin-logging/pull/391)
- Bump actions/deploy-pages from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/392](https://github.com/oshai/kotlin-logging/pull/392)
- Bump actions/cache from 3.3.2 to 3.3.3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/393](https://github.com/oshai/kotlin-logging/pull/393)
- Log marker and stacktrace on Darwin by
[@&#8203;Gaming32](https://github.com/Gaming32) in
[https://github.com/oshai/kotlin-logging/pull/379](https://github.com/oshai/kotlin-logging/pull/379)

#### New Contributors

- [@&#8203;Gaming32](https://github.com/Gaming32) made their first
contribution in
[https://github.com/oshai/kotlin-logging/pull/379](https://github.com/oshai/kotlin-logging/pull/379)

**Full Changelog**:
oshai/kotlin-logging@6.0.2...6.0.3

###
[`v6.0.2`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.2)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.1...6.0.2)

#### What's Changed

- Bump multiplatform from 1.9.21 to 1.9.22 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/385](https://github.com/oshai/kotlin-logging/pull/385)
- Remove detekt by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/387](https://github.com/oshai/kotlin-logging/pull/387)
- Add workflow to publish Dokka HTML docs to project site by
[@&#8203;EdricChan03](https://github.com/EdricChan03) in
[https://github.com/oshai/kotlin-logging/pull/383](https://github.com/oshai/kotlin-logging/pull/383)

#### New Contributors

- [@&#8203;EdricChan03](https://github.com/EdricChan03) made their
first contribution in
[https://github.com/oshai/kotlin-logging/pull/383](https://github.com/oshai/kotlin-logging/pull/383)

**Full Changelog**:
oshai/kotlin-logging@6.0.1...6.0.2

###
[`v6.0.1`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.1)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.0...6.0.1)

#### What's Changed

- Bump com.diffplug.spotless from 6.22.0 to 6.23.3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/377](https://github.com/oshai/kotlin-logging/pull/377)
- Bump actions/setup-java from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/376](https://github.com/oshai/kotlin-logging/pull/376)
- Bump org.jetbrains.dokka from 1.8.20 to 1.9.10 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/366](https://github.com/oshai/kotlin-logging/pull/366)

**Full Changelog**:
oshai/kotlin-logging@6.0.0...6.0.1

###
[`v6.0.0`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.0)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/5.1.4...6.0.0)

#### What's Changed

- Update Kotlin to 1.9.21 by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/380](https://github.com/oshai/kotlin-logging/pull/380)

#### New Contributors

- [@&#8203;AzimMuradov](https://github.com/AzimMuradov) made their
first contribution in
[https://github.com/oshai/kotlin-logging/pull/380](https://github.com/oshai/kotlin-logging/pull/380)

**Full Changelog**:
oshai/kotlin-logging@5.1.2...6.0.0

###
[`v5.1.4`](https://github.com/oshai/kotlin-logging/releases/tag/5.1.4)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/5.1.1...5.1.4)

#### What's Changed

- fix - protect from uncontrolled format string by
[@&#8203;oshai](https://github.com/oshai) in
[https://github.com/oshai/kotlin-logging/pull/381](https://github.com/oshai/kotlin-logging/pull/381)

**Full Changelog**:
oshai/kotlin-logging@5.1.1...5.1.4

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/StefanLobbenmeier/yt-dlp-compose).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy45My4xIiwidXBkYXRlZEluVmVyIjoiMzcuMTM1LjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
nikclayton referenced this pull request in pachli/pachli-android Mar 4, 2024
….0.3 (#362)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[io.github.oshai:kotlin-logging-jvm](https://github.com/oshai/kotlin-logging)
| `5.1.4` -> `6.0.3` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.oshai:kotlin-logging-jvm/5.1.4/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.oshai:kotlin-logging-jvm/5.1.4/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[io.github.oshai:kotlin-logging-jvm](https://github.com/oshai/kotlin-logging)
| `6.0.1` -> `6.0.3` |
[![age](https://developer.mend.io/api/mc/badges/age/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/io.github.oshai:kotlin-logging-jvm/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/io.github.oshai:kotlin-logging-jvm/6.0.1/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/io.github.oshai:kotlin-logging-jvm/6.0.1/6.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>oshai/kotlin-logging
(io.github.oshai:kotlin-logging-jvm)</summary>

###
[`v6.0.3`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.3)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.2...6.0.3)

#### What's Changed

- Add Kotlin/Wasm (JS browser) support by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/388](https://github.com/oshai/kotlin-logging/pull/388)
- Bump com.diffplug.spotless from 6.23.3 to 6.24.0 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/390](https://github.com/oshai/kotlin-logging/pull/390)
- Bump actions/upload-pages-artifact from 2 to 3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/391](https://github.com/oshai/kotlin-logging/pull/391)
- Bump actions/deploy-pages from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/392](https://github.com/oshai/kotlin-logging/pull/392)
- Bump actions/cache from 3.3.2 to 3.3.3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/393](https://github.com/oshai/kotlin-logging/pull/393)
- Log marker and stacktrace on Darwin by
[@&#8203;Gaming32](https://github.com/Gaming32) in
[https://github.com/oshai/kotlin-logging/pull/379](https://github.com/oshai/kotlin-logging/pull/379)

#### New Contributors

- [@&#8203;Gaming32](https://github.com/Gaming32) made their first
contribution in
[https://github.com/oshai/kotlin-logging/pull/379](https://github.com/oshai/kotlin-logging/pull/379)

**Full Changelog**:
oshai/kotlin-logging@6.0.2...6.0.3

###
[`v6.0.2`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.2)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.1...6.0.2)

#### What's Changed

- Bump multiplatform from 1.9.21 to 1.9.22 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/385](https://github.com/oshai/kotlin-logging/pull/385)
- Remove detekt by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/387](https://github.com/oshai/kotlin-logging/pull/387)
- Add workflow to publish Dokka HTML docs to project site by
[@&#8203;EdricChan03](https://github.com/EdricChan03) in
[https://github.com/oshai/kotlin-logging/pull/383](https://github.com/oshai/kotlin-logging/pull/383)

#### New Contributors

- [@&#8203;EdricChan03](https://github.com/EdricChan03) made their
first contribution in
[https://github.com/oshai/kotlin-logging/pull/383](https://github.com/oshai/kotlin-logging/pull/383)

**Full Changelog**:
oshai/kotlin-logging@6.0.1...6.0.2

###
[`v6.0.1`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.1)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/6.0.0...6.0.1)

#### What's Changed

- Bump com.diffplug.spotless from 6.22.0 to 6.23.3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/377](https://github.com/oshai/kotlin-logging/pull/377)
- Bump actions/setup-java from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/376](https://github.com/oshai/kotlin-logging/pull/376)
- Bump org.jetbrains.dokka from 1.8.20 to 1.9.10 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/oshai/kotlin-logging/pull/366](https://github.com/oshai/kotlin-logging/pull/366)

**Full Changelog**:
oshai/kotlin-logging@6.0.0...6.0.1

###
[`v6.0.0`](https://github.com/oshai/kotlin-logging/releases/tag/6.0.0)

[Compare
Source](https://github.com/oshai/kotlin-logging/compare/5.1.4...6.0.0)

#### What's Changed

- Update Kotlin to 1.9.21 by
[@&#8203;AzimMuradov](https://github.com/AzimMuradov) in
[https://github.com/oshai/kotlin-logging/pull/380](https://github.com/oshai/kotlin-logging/pull/380)

#### New Contributors

- [@&#8203;AzimMuradov](https://github.com/AzimMuradov) made their
first contribution in
[https://github.com/oshai/kotlin-logging/pull/380](https://github.com/oshai/kotlin-logging/pull/380)

**Full Changelog**:
oshai/kotlin-logging@5.1.2...6.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/pachli/pachli-android).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish Dokka HTML docs on project site
2 participants