fix: trigger pipeline for non main branches #11

mattlewis92 · 2022-02-17T14:16:04Z

Hey there! I decided to give this action a go based on this blog post but I found that it kept trying to trigger the pipeline on the main branch rather than the branch which triggered the job. After a bit of digging I found the issue was that the tag and branch aren't being passed correctly to the circleci pipeline according to the docs

Also included several other fixes to make contributing easier (done as separate commits for a cleaner git history)

mattlewis92 · 2022-02-17T14:16:15Z

.gitignore

+.DS_Store
+.idea


Adding this for webstorm users

mattlewis92 · 2022-02-17T14:17:06Z

README.md

@@ -23,7 +23,7 @@ jobs:
    steps:
      - name: <customize name>
        id: <customize id>
-        uses: CircleCI-Public/[email protected]
+        uses: CircleCI-Public/[email protected].4


When I copy pasted this I realised I wasn't on the latest version of the action. You may also want to maintain a v1 tag and update that on every release.

mattlewis92 · 2022-02-17T14:17:40Z

index.js

@@ -18,13 +18,13 @@ info(`Org: ${repoOrg}`);
 info(`Repo: ${repoName}`);
 const ref = context.ref;

-const branch = () => {
+const getBranch = () => {


Renamed these so the intent is a bit clearer. I think if you were doing if (getTag) { it would have been more obvious there was a bug here

mattlewis92 · 2022-02-17T14:19:38Z

index.js

 if (tag) {
-  Object.assign(parameters, { GHA_Tag: tag() });


GHA_Tag and GHA_Branch were not documented in the readme and if they were set would have caused the circle build to fail as they wouldn't have been defined on the circle config. It doesn't make sense to pass them as parameters as they can be determined from within any job inside of circleci so I just removed them

You are correct! I was trying to figure out why this code would be here (my fault obviously), and I think I found the broken train of thought. I think the original intent may have been to append "branch" and "tag" to the body.

You are correct we would not need either of those parameters, which led me to question why I put them there. I think the intent was the ensure the pipeline was triggered on a branch or tag, and it appears that is likely not working now.

https://circleci.com/docs/api/v2/#operation/triggerPipeline

Payload sample:

{ "branch": "feature/design-new-api", "tag": "v3.1.4159", "parameters": { "deploy_prod": true } }

Rather than remove them I think we might want to make a few adjustments to ensure the branch/tag key are added to the body so that the pipeline is triggered at the right reference

For sure! That's what we're now doing here (and was the main source of the bug):

trigger-circleci-pipeline-action/index.js

Lines 57 to 61 in d0dabb5

if (tag) {

Object.assign(body, { tag });

} else {

Object.assign(body, { branch });

}

Based on how we check the ref field it looks like it's not possible to have both a tag AND a branch so I think it's correct to only pass one or the other

trigger-circleci-pipeline-action/index.js

Line 22 in d0dabb5

if (ref.startsWith("refs/heads/")) {

trigger-circleci-pipeline-action/index.js

Line 28 in d0dabb5

if (ref.startsWith("refs/tags/")) {

mattlewis92 · 2022-02-17T14:19:40Z

index.js

@@ -51,16 +51,24 @@ const body = {
  parameters: parameters,
 };

+const tag = getTag();
+const branch = getBranch();
+
 if (tag) {


Previously this was always truthy as we were referencing the function rather than its return value.

mattlewis92 · 2022-02-17T14:20:07Z

package.json

@@ -24,11 +24,10 @@
  "dependencies": {
    "@actions/core": "^1.6.0",
    "@actions/github": "^5.0.0",
-    "axios": "^0.24.0",
-    "install": "^0.13.0",


I think these 2 were added as accidental dependencies

mattlewis92 · 2022-02-17T14:20:35Z

package.json

  },
  "devDependencies": {
+    "@vercel/ncc": "^0.33.3",


Added ncc as a dev dependency so things just work out the box without having to install it globally

rowi1de · 2022-03-04T07:55:34Z

Looks like this #12 or?

mattlewis92 · 2022-03-07T15:28:11Z

Looks like this #12 or?

I think we're running into the same problem here, where the action always triggers the main branch's pipeline, this PR fixes it so it only triggers the circle pipeline for the branch or tag that triggered the github action

mattlewis92 · 2022-03-07T15:29:07Z

@KyleTryon any update on if we can get this merged soon? 😄

KyleTryon · 2022-03-08T17:52:24Z

Apologies for the delay @mattlewis92. I reviewed the code, rebuilt it to verify and as there were no changes, immediately tagged your change.
https://github.com/CircleCI-Public/trigger-circleci-pipeline-action/releases/tag/v1.0.4

🙇 thank you

mattlewis92 · 2022-03-08T17:59:14Z

Awesome, thank you so much!! 🙌

milosivanovic · 2022-04-01T06:36:35Z

Currently, GitHub references the default/main branch instead of the branch the PR was created from for all issue_comment events.

I'm trying to create a comment trigger so if I type something like /deploy in a PR comment, GitHub Actions trigger a CircleCI build of the PR. As seen in the GitHub documentation, issue_comment refs are refs/heads/<default_branch> instead of the PR branch, so this always builds the main branch, even with @mattlewis92's fix.

There are a few complaints regarding this here: actions/checkout#331 (comment)

Is there any way to make issue_comment events trigger the right (non-main) branch in trigger-circleci-pipline-action?

It may be preferable to set a v1 link and keep that updated to point to the latest release. Also mentioned in PR CircleCI-Public#11: CircleCI-Public#11 (comment)

joshS28 · 2022-05-19T22:41:49Z

Same problem here with @milosivanovic .

Experiencing the same problem myself and have left a comment here actions/checkout#331 trying to see if there exists a solution.

It seems like CircleCI is not picking up the branch correctly, is there an example of passing the branch as a parameter?

* support events that don't have a payload For example, 'on: schedule' does not have a payload[1], which results in an error when attempting to use this action: TypeError: Cannot read property 'url' of undefined This commit updates the code to use the `repo` attribute instead of parsing out the repo org/name from the repo URL. 1. https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule * prepare build ``` npm run lint && npm run format && npm run build ``` Added this as a separate commit, as I don't know anything about npm packages, and it's not clear if all of the package list changes are desirable. * README: unify version It may be preferable to set a v1 link and keep that updated to point to the latest release. Also mentioned in PR #11: #11 (comment)

* support events that don't have a payload For example, 'on: schedule' does not have a payload[1], which results in an error when attempting to use this action: TypeError: Cannot read property 'url' of undefined This commit updates the code to use the `repo` attribute instead of parsing out the repo org/name from the repo URL. 1. https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule * prepare build ``` npm run lint && npm run format && npm run build ``` Added this as a separate commit, as I don't know anything about npm packages, and it's not clear if all of the package list changes are desirable. * README: unify version It may be preferable to set a v1 link and keep that updated to point to the latest release. Also mentioned in PR CircleCI-Public#11: CircleCI-Public#11 (comment)

mattlewis92 added 4 commits February 17, 2022 14:03

chore: add .idea to gitignore

ae7c85e

chore: fix dependencies

938abbe

fix: trigger pipeline for non main branches

577dc1d

docs(readme): point to latest version

d0dabb5

mattlewis92 commented Feb 17, 2022

View reviewed changes

.gitignore

.DS_Store

.idea

Copy link

Contributor Author

mattlewis92 Feb 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this for webstorm users

KyleTryon reacted with heart emoji

mattlewis92 commented Feb 17, 2022

View reviewed changes

rowi1de mentioned this pull request Mar 4, 2022

Request: How to trigger for a different branch #12

Closed

1 task

KyleTryon approved these changes Mar 8, 2022

View reviewed changes

KyleTryon merged commit 7b29cee into CircleCI-Public:main Mar 8, 2022

suonto mentioned this pull request May 23, 2022

Any way to checkout PR from issue_comment event? actions/checkout#331

Open

jblacker mentioned this pull request Jul 17, 2023

Bug: Triggering via issue_comment Action Kicks Off Workflow For Incorrect Commit/Branch #61

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: trigger pipeline for non main branches #11

fix: trigger pipeline for non main branches #11

mattlewis92 commented Feb 17, 2022 •

edited

Loading

mattlewis92 Feb 17, 2022

mattlewis92 Feb 17, 2022

mattlewis92 Feb 17, 2022

mattlewis92 Feb 17, 2022

KyleTryon Feb 24, 2022

mattlewis92 Feb 24, 2022

mattlewis92 Feb 24, 2022

mattlewis92 Feb 17, 2022

mattlewis92 Feb 17, 2022

mattlewis92 Feb 17, 2022

rowi1de commented Mar 4, 2022

mattlewis92 commented Mar 7, 2022

mattlewis92 commented Mar 7, 2022

KyleTryon commented Mar 8, 2022

mattlewis92 commented Mar 8, 2022

milosivanovic commented Apr 1, 2022 •

edited

Loading

joshS28 commented May 19, 2022

	if (tag) {
	Object.assign(body, { tag });
	} else {
	Object.assign(body, { branch });
	}

fix: trigger pipeline for non main branches #11

fix: trigger pipeline for non main branches #11

Conversation

mattlewis92 commented Feb 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rowi1de commented Mar 4, 2022

mattlewis92 commented Mar 7, 2022

mattlewis92 commented Mar 7, 2022

KyleTryon commented Mar 8, 2022

mattlewis92 commented Mar 8, 2022

milosivanovic commented Apr 1, 2022 • edited Loading

joshS28 commented May 19, 2022

mattlewis92 commented Feb 17, 2022 •

edited

Loading

milosivanovic commented Apr 1, 2022 •

edited

Loading