lightweight tags create no "create event" in github actions #271

Activity

1. diefans

   added

   type: bug

   on Sep 22, 2020
2. diefans

   added 4 commits that reference this issue on Sep 22, 2020

   fix(commitizen-tools#271): add annotated_tag option to bump

   ...

   311e1c7

   fix(commitizen-tools#271): add annotated_tag option to bump

   ...

   d06dff4

   fix(commitizen-tools#271): add annotated_tag option to bump

   ...

   646e567

   fix(commitizen-tools#271): add annotated_tag option to bump

   ...

   ad554a4
3. woile commented on Sep 23, 2020

   

   woile

   on Sep 23, 2020

   Member

   More actions

   thanks for the finding! some questions, how did you find this problem? could you point the GA documentation where they mention lightweight tag don't create events? I couldn't find it.

   I'll run some tests in to verify it as well 💪

   👍React with 👍1Reacted by Wei Lee
4. diefans commented on Sep 23, 2020

   

   diefans

   on Sep 23, 2020

   ContributorAuthor

   More actions

   I have no documentation at hand. But as far as I know, lightweight tags are not "real" objects in git and have also no creation date. You can see this via git for-each-ref where the objecttype of a lightweight tag is commit and for an annotated tag it is tag (also find this in my unit test).
   So basically I found this by trying github actions to do something after tag creation (see https://docs.github.com/en/actions/reference/events-that-trigger-workflows#create), but there was no event triggered after commitizen created the "tag". So I just created a dummy annotated tag and my workflow was running - so I came to that conclusion....
5. Lee-W commented on Sep 23, 2020

   

   Lee-W

   on Sep 23, 2020

   Member

   More actions

   We use the following syntax to detect release which might be the reason why we did not encounter such problem.

   on:
     push:
       tags:
         - 'v*'

   But I think it's a feature we could have. Thanks for great work 🙂 I'll also run some test to verify it.
6. diefans commented on Sep 23, 2020

   

   diefans

   on Sep 23, 2020

   Last edited by diefans

   ContributorAuthor

   More actions

   @Lee-W I do not really understand how this is working for you:
   I have a job running basically the example in your docs:

     bump-version:
       if: github.ref == 'refs/heads/master'
       runs-on: ubuntu-latest
       name: "Bump version and create changelog with commitizen"
       needs:
         - build
       steps:
         - name: Check out
           uses: actions/checkout@v2
           with:
             token: '${{ secrets.GITHUB_TOKEN }}'
             fetch-depth: 0
         - name: Create bump and changelog
           uses: commitizen-tools/commitizen-action@master
           with:
             github_token: ${{ secrets.GITHUB_TOKEN }}
   

   The job appears to work fine:

   Configuring git user and email...
   Runnung cz...
   bump: version 0.2.1 → 0.2.2
   tag to create: 0.2.2
   increment detected: PATCH
   
   Done!
   Pushing to branch...
   To https://github.com/*/*.git
      f76d488..8bdc82d  HEAD -> master
    * [new tag]         0.2.2 -> 0.2.2
   Done.
   

   I also have a debug workflow:

   name: debug
   on:
     push:
       tags:
         - "*"
     create:
   
   jobs:
     debug:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - run: echo ${{ github.ref }}
         - run: echo ${{ toJSON(github.event) }}
   

   but this gets never triggered after the "tag" is "pushed" via the bump-version job.
7. woile commented on Sep 23, 2020

   

   woile

   on Sep 23, 2020

   Last edited by woile

   Member

   More actions

   secrets.GITHUB_TOKEN won't trigger another workflow. It's like using [skip ci] in other CI's.

   You have to use a personal token like here: https://github.com/commitizen-tools/commitizen/blob/master/.github/workflows/bumpversion.yml

   I asked the same in the github action discussion board:
   https://git.xywcc.community/t/action-does-not-trigger-another-on-push-tag-action/17148/2

   Note: for some reason your PERSONAL_TOKEN must be provided to the checkout step 🤷‍♂️

   I think in our case (commitizen) that's why it was failing. Now we are waiting for next release 🤞 hahahha

   👍React with 👍1Reacted by Wei Lee
8. diefans

   added a commit that references this issue on Sep 23, 2020

   fix(commitizen-tools#271): add annotated_tag option to bump

   ...

   d2b0ebe
9. diefans commented on Sep 23, 2020

   

   diefans

   on Sep 23, 2020

   ContributorAuthor

   More actions

   @woile this explains a lot...
10. woile commented on Sep 23, 2020

    

    woile

    on Sep 23, 2020

    Member

    More actions

    Yeah I lost a few hairs dealing with it.

    The documentation explains how to add a PERSONAL TOKEN, I think we should mention why though.

    https://commitizen-tools.github.io/commitizen/tutorials/github_actions/
11. woile

    added a commit that references this issue on Nov 21, 2020

    docs: inform about GITHUB_TOKEN vs PERSONAL_ACCESS_TOKEN in Github ac…

    ...

    This issue will close once commit 58c5a92 is merged into the 'master' branch.

    58c5a92
12. woile

    closed this as completedin #310on Nov 21, 2020
13. cliles

    added 4 commits that reference this issue on Jan 15, 2021

    fix(commitizen-tools#271): add annotated_tag option to bump

    ...

    10543d7

    fix(commitizen-tools#271): add annotated_tag option to bump

    ...

    44385ef

    feat(commitizen-tools#271): add annotated_tag option to bump

    ...

    90a2acb

    feat(commitizen-tools#271): enable creation of annotated tags when bu…

    ...

    20a54bf