Skip to content

[Question] Action integration in mkdocs workflow #1

@do-me

Description

@do-me

Thanks for providing this GitHub action! 

I'm currently trying to use your compression action in my mkdocs workflow with GitHub actions but I run into issues with branches/actions. See my test repo and the action docs.

Current workflow

The workflow is simple: whenever someone pushes to the repo, the mkdocs CI action is triggered and the site is deployed. 

The main branch contains raw (editable) markdown files which are then converted to normal html in my gh-pages branch. The gh-pages branch serves for automatic deploy with GitHub Pages.

Idea

I have two possible ideas of how to integrate your compression. 

  1. Integrate it directly in the standard gh-pages action. Problem: it does everything automatically and does not offer simple customization. That's the reason why I'd prefer the second idea.
  2. Create a third branch called deploy. So when main registers a change, everything is executed as normal and gh-pages is populated with the html files. How could I then use your action to take the input from gh-pages (when ready) compress it with your action and push to deploy? I saw the path variable, but still didn't manage to link the branches and your action. 

It rather might be a question for the mkdocs community but maybe other static site generators like Hugo, Jekyll etc. might profit from it as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions