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

env.deployment_status should be a job output #99

Open
rossjrw opened this issue Jan 10, 2025 · 0 comments
Open

env.deployment_status should be a job output #99

rossjrw opened this issue Jan 10, 2025 · 0 comments
Labels
bug Something isn't working

Comments

@rossjrw
Copy link
Owner

rossjrw commented Jan 10, 2025

JamesIves/github-pages-deploy-action sets env.deployment_status and steps.[id].outputs.deployment-status to indicate whether the deployment succeeded / was skipped / failed etc. I use this to determine whether to leave a comment on the PR.

As of #97, everything that my action generates to use in its comment is also provided as an output so the user can write a comment with at least the same amount of information. The exception is github-pages-deploy-action's deployment_status, which is implicitly generated by that action and therefore never gets mentioned in my documentation, even though it's important.

Also, all of my outputs are exposed as step outputs and might well be accessible as env vars but I don't document that and I'm not going to make any guarantees about it either. The intended way to use them is via their step outputs. deployment_status cannot be accessed as a step output because, for a user of my action, there is no github-pages-deploy-action, so it's only available as an env var, and that's inconsistent and lame.

github-pages-deploy-action's deployment_status should be re-exported by my action as a step output so it can be accessed consistently.

@rossjrw rossjrw added the bug Something isn't working label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant