Giters

pmgbergen / porepy

Python Simulation Tool for Fractured and Deformable Porous Media

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Workflow: Rebase docs on develop upon push to develop

vlipovac opened this issue · comments

commented

The idea is to use simple console instructions in a workflow .yml-file to perform a standard git rebase by checking out the
repo in a temporary directory and perform respective operations inside.

If it works, we lose a dependency on third-part actions.

commented

I suggest the following course of action

  • 1. A workflow/action to ensure no folder /docs/ is contained in a PR to develop
  • 2. Another action asserting that PR to docs contains only modifications in folder /docs/
  • 3. A manual synchronization of docs with develop, shortly before the last point.
  • 4. Introduce Action which rebases docs onto develop once a PR-Merger is performed.

General idea to write actions with console commands doing above with standard git commands.
Mind the authorization inside each workflow (Token?) since both branches are protected.

Tests and development to be conducted in the playground repo get_to_know_github. Need GH of organization pmgbergen for actions to work.

commented

@vlipovac Do I understand you correctly that point 3 is a one-time manual operation while the rest is automatized? If so, this sounds great.

commented

@vlipovac Do I understand you correctly that point 3 is a one-time manual operation while the rest is automatized? If so, this sounds great.

Yes, step 3 is a one-time manual operation, to be done right before the workflow from 4 is introduced (including a coordination that no PR to develop is performed while steps 3-4 are conducted).

commented

Put on hold for now, until documentation of the package is brought to an acceptable level and resources freed for committing to documentation maintenance.

References for how to approach this:
https://github.com/ammaraskar/sphinx-action