C2DH / journal-of-digital-history-ipynb-preflight-action

This GitHub action provides a set of tools to facilitate the life of reviewers
GNU Affero General Public License v3.0
0 stars 0 forks source link

Integrate a new job named syncNotebook #33

Closed eliselavy closed 1 week ago

eliselavy commented 2 months ago

The goal of this job is to synchronize the md and the ipynb files. Usually we create a md file in order to integrate the correction made for the copy-editing. The person in charge of copy-editing edit the md file and integrate the correction. The person do a pull request. At the merge , the job shoudl be triggered to sync the notebook

Pair notebook with a md file Look at here:

jupytext --set-formats ipynb,md article.ipynb

An article.md file is created.

run following command to synchronize the md file and the ipynb

jupytext --sync article.ipynb

Can you look at this also? Not sure to know how this can be triggered? manually ?

https://jupytext.readthedocs.io/en/latest/using-pre-commit.html

eliselavy commented 1 week ago

@memerchik are you sure it will work as master it put as branch name? https://github.com/C2DH/journal-of-digital-history-ipynb-preflight-action/blob/master/.github/workflows/sync-notebook.yml

 name: committing changes
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: Automated commit
          branch: master
          create_branch: false

I need to use it here: https://github.com/jdh-observer/6EWgjJtoiW6R/pull/6

eliselavy commented 1 week ago

ok tested - work master replaced with the current branch placeholder