Skip to content

feat: Automating Documentation Versioning on Release using github action #2571

@oben01

Description

@oben01

Describe the feature you'd like to request

TODO list

  • Remove chart app.
  • Disable Homarr repository scan in Renovate
  • Don't forget to regenerate a new secret key before merging the PR.
  • Comments AutoMerging in tests

Automatic updates

  1. Trigger on Release: Detect the new version from the main repository (e.g., 1.11.0).

  2. Create a PR in the chart repository, run documentation update something like renovate workflow in the chart and automerge it

  3. Create a PR in the Documentation Repository copy the chart documentation

When a new major or minor version is released in the main repository un the the command

pnpm run docusaurus docs:version 1.13.0
  • Commit the changes.
  1. Automatically merge the PR to master.

Manual updates

If we need to update already merge documentation:

  1. Update the chart docs and merge it to main branch
  2. run a manual github workflow to update the homarr documentation of the specific version
  • Check the latest version of the app in the chart repository
  • if the version exist in the documentation repository then update the next folder and release the same version

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions