trsvchn / colab-badge-action Goto Github PK

Hi,

Finally i found a solution to what i'm looking for after many days.
But couldn't quite understand how this works.
Can you please make a small tutorial or steps how to install and use the 'colab-badge-action'.
Appreciate your help.
Thank you.

The pull_request workflow event uses a different value for GITHUB_REF that does not include the branch name (in contrast to the push event); instead, it includes information about the PR, e.g. refs/pull/72/merge. This causes git push to fail with errors like this:

! [remote rejected] HEAD -> refs/pull/72/merge (deny updating a hidden ref)

Add checks for returncodes of subprocess calls for committing and pushing funs. Since, currently, action doesn't catch git-related errors.
Related to #3

Hello!

It seems that with the default settings, pasted below I am getting an error where the branch name keeps getting switched to master even though I am using the default settings. See image (see below).

Thank you for your help!
Steven

name: Badges workflow
on: [workflow_dispatch, push]
jobs:
  build:
    name: Badges Job
    runs-on: ubuntu-latest
    steps:
      - name: Checkout first
        id: checkout
        uses: actions/checkout@v2

      - name: Add/Update badges
        id: badges
        uses: trsvchn/colab-badge-action@v4
        with:
          check: 'all'
          update: true
          verbose: true

      - name: push
        uses: actions-x/commit@v6
        with:
          message: Update Colab badges with GitHub Actions

When this action adds a commit to a PR for merging into master, this commit is not triggering CI actions that are normally triggered by push and pull_request events that touch master. Any ideas?

Test Pull Request event from a fork

Looks like action doesn't handle the case where file name includes white spaces. e.g. My notebook.ipynb

What we want to achieve is this

jobs:
  build:
    steps:
      - name: Checkout Action
        uses: actions/checkout@v2

      - name: Colab Badge Action
        # Add/update colab badges (modify files)
        uses: trsvchn/colab-badge-action@new_version
        with:
          ...
     
      - name: Commit and Push Changed Notebooks
        # Use your favorite action here
        uses: action@commit
        with:
          ...

Summary:

Colab badges in Jupyter Notebooks update across branches when merging or pushing, but Colab badges in Markdown files do not update. They will be created just fine, but not updated once created.

Steps to Reproduce

1. Make a new repo, clone it
2. Checkout a new branch git checkout -b test
3. Create a Jupyter notebook file named test at the root of the repository
4. Make a markdown cell with {{ badge }}.
5. Create a markdown file: `echo '
6. Write first line {{ badge test }}
7. Commit: git commit -am "test"
8. Push: git push -u origin test
9. Watch the action complete, hopefully successfully. Confirm that the branch test
   • created a new badge in test.ipynb
   • created a new badge in test.md
   • Note that the paths in both badges respect the current test branch.
10. Create a pull request with the test branch to the main branch.
11. Watch the github action do the following:
    - update the badge in test.ipynb
    - Skip updating the badge in test.md <<-- This is the bug.

Note: You can inspect the action since the yaml below creates verbose output and see that

Goes in .github/workflows/colab_badge.yml

name: Badges workflow
on: [push]

jobs:
  build:
    name: Badges Job
    runs-on: ubuntu-latest
    steps:
      - name: Checkout first
        id: checkout
        uses: actions/checkout@v2

      - name: Add/Update badges
        id: badges
        uses: trsvchn/colab-badge-action@v4
        with:
          check: 'all'
          update: true
          verbose: true

      - name: push
        uses: actions-x/commit@v6
        with:
          message: Update Colab badges with GitHub Actions