plone / plone/documentation

Automatically update submodules when other repos push to `main`

Open
#1,214 10 comments 0 reactions 2 assignees View on GitHub

Nobody has claimed this yet.

04 type: enhancement 12 prio: high
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

Plone Documentation versions affected
  • 5.x
  • 6.x
Description

Currently whenever there is a push to master for either repo plone/volto or plone/plone.restapi, we manually need to remember to update the submodule. See https://6.docs.plone.org/contributing/index.html#editing-external-package-documentation, Step 7.

cd ../..

# For plone.restapi
git add submodules/plone.restapi
git commit -m "Update submodules/plone.restapi tip"

# For volto
git add submodules/volto
git commit -m "Update submodules/volto tip"

git push

It would be great to handle this automatically in GitHub Actions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.