Skip to content

Conversation

@ZacSweers
Copy link
Collaborator

Ported from Molecule and modified for Dokka v2

Resolves #2011

@ZacSweers
Copy link
Collaborator Author

Not super familiar with the actions used for releasing here but the newer dokka multimodule config outputs it to docs/2.x

Comment on lines +26 to +28
- name: Extract release notes
id: release_notes
uses: ffurrer2/extract-release-notes@v2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to switch to keep-a-changelog format for this to work.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want that?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. We use it mostly everywhere else.

with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: site
FOLDER: docs/2.x/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait... it outputs by default in the repo and not in build/?!?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no the current dokka config outputs it there (copied from mkdocs though docs/ is excluded here so seems to be leftover as a target), but I can change it since we don't have an mkdocs site

@JakeWharton
Copy link
Collaborator

Anything left here?

@ZacSweers
Copy link
Collaborator Author

Talked with @swankjesse offline, gonna hold off till after 2.0 because I'm not sure how to fit his migration guide within the structure required by keep-a-changelog

@JakeWharton
Copy link
Collaborator

JakeWharton commented Nov 26, 2025

The only thing needed for keep-a-changelog is the version header. You can put whatever you want beneath it.

Example:

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.

Dokka 2 multi-module

3 participants