Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.2.2 file not found regression #74

Open
jrobison-sb opened this issue May 31, 2024 · 8 comments
Open

3.2.2 file not found regression #74

jrobison-sb opened this issue May 31, 2024 · 8 comments

Comments

@jrobison-sb
Copy link

When I attempt to use the newly released version 3.2.2 of this action, it fails. This was working nicely for us on prior versions for a long time.

Reproduction case

This workflow: https://github.com/jrobison-sb/devops-3113/blob/main/.github/workflows/example.yml

This issue form: https://github.com/jrobison-sb/devops-3113/blob/main/.github/ISSUE_TEMPLATE/example.yml?plain=1

Results in this workflow / this error: https://github.com/jrobison-sb/devops-3113/actions/runs/9320842003/job/25658517099#step:3:8

Thanks.

@gr2m
Copy link
Collaborator

gr2m commented May 31, 2024

hmm the reason is that the dist/ folder does not exist in https://github.com/stefanbuck/github-issue-parser/tree/v3.2.0. Compare to https://github.com/stefanbuck/github-issue-parser/tree/v3.1.1 where it does exist.

I recommend to use stefanbuck/[email protected] for the time being. In order to fix this problem for good, I recommend we mirror the setup of https://github.com/actions/create-github-app-token. I won't have time to look into it myself right now though

@gr2m
Copy link
Collaborator

gr2m commented May 31, 2024

or better, use stefanbuck/github-issue-parser@v3

@jrobison-sb
Copy link
Author

@gr2m thanks for your reply.

Yes, pinning stefanbuck/[email protected] unblocked us on this, at least for now.

I would expect stefanbuck/github-issue-parser@v3 to be the same thing as v3.2.0, since v3.2.0 is currently the latest release, though our desire to pin v3.2.0 isn't necessarily the same thing as pinning v3. We previously did use @v3, and got bit by a breaking change which shipped with v3.2.0. So as part of modifying our usage to fix that breaking change, we wanted specific version pins which will help us avoid similar breaking changes in the future.

@gr2m
Copy link
Collaborator

gr2m commented May 31, 2024

what is the breaking change though? It was definitely not intended, I thought this was an internal implementation detail

@jrobison-sb
Copy link
Author

jrobison-sb commented May 31, 2024

@gr2m

The breaking change is that the json result isn't in the home directory anymore, so cat ${HOME}/issue-parser-result.json doesn't work anymore. We had been successfully using this for a long time:

      - uses: stefanbuck/github-issue-parser@v3
        id: issue-parser
        with:
          template-path: .github/ISSUE_TEMPLATE/prep-for-software-update.yml # optional but recommended

      - name: Read input from the issue, just for ease of troubleshooting if something was wrong
        run: cat ${HOME}/issue-parser-result.json | jq -S .

But upon the release of v3.2.0, it broke (this comes from a non-public repo, not the same one I linked initially):
image

On 3.2.0 the json result should now be referenced by way of cat ${{ runner.temp }}/issue-parser-result.json. We attempted to modify our usage and pin 3.2.0 at the same time, to protect us from similar issues in the future, and that's how I arrived at the missing dist folder.

Thanks again for following up on this.

@gr2m
Copy link
Collaborator

gr2m commented May 31, 2024

reverting via #75

@gr2m
Copy link
Collaborator

gr2m commented May 31, 2024

@joshjohanning
Copy link
Contributor

Ahh. I see how this could have caused an issue for folks referencing the parsed json file. Bummer!

I think it makes a lot of sense for the runner.temp to be a v4 instead. And also in v4, there should be an additional output parameter for the file path so that people can use the output vs a ‘hardcoded’ file path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants