Skip to content

Conversation

@stevenzeck
Copy link
Contributor

NOTE: This PR is for the branch main. This PR adds a new GitHub action to generate documentation. It does this by the following:

  1. Every time a push is made to the branch main, it runs the action. After installing the dependencies and everything, it runs Dokka to generate markdown files for each of the submodules.
  2. After that is complete, Mkdocs/mike is run to transform the markdown to an HTML ready website that is committed to the gh-pages branch

Things to keep in mind for the future:

  1. Whenever a push is made to main for a new release, make sure update-docs.yml is updated so that the LATEST_VERSION variable is the release number. Not sure if that version number can be pulled from an gradle file or not
  2. Any pushes to main without a change in the release number will simply overwrite the previous documentation for that release number. This is useful for adding new documentation, changing verbiage in it, etc.

@mickael-menu
Copy link
Member

  1. Whenever a push is made to main for a new release, make sure update-docs.yml is updated so that the LATEST_VERSION variable is the release number. Not sure if that version number can be pulled from an gradle file or not

You can use the following to get the latest tag in the current branch matching the pattern [0-9]* (works with dots too somehow):

$ git describe --tag --match [0-9]* --abbrev=0
2.1.0

Copy link
Member

@mickael-menu mickael-menu left a comment

Choose a reason for hiding this comment

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

Thanks, this will be very useful!

@mickael-menu mickael-menu merged commit d245877 into readium:main Oct 15, 2021
mickael-menu pushed a commit to mickael-menu/kotlin-toolkit that referenced this pull request Oct 15, 2021
mickael-menu pushed a commit to mickael-menu/kotlin-toolkit that referenced this pull request Oct 15, 2021
mickael-menu pushed a commit to mickael-menu/kotlin-toolkit that referenced this pull request Oct 15, 2021
@stevenzeck stevenzeck deleted the toolkit-ghpages branch October 15, 2021 15:54
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.

2 participants