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

Docs: needs more clarifications on default behaviour #215

Closed
ahmadnassri opened this issue Nov 4, 2020 · 0 comments · Fixed by #299
Closed

Docs: needs more clarifications on default behaviour #215

ahmadnassri opened this issue Nov 4, 2020 · 0 comments · Fixed by #299

Comments

@ahmadnassri
Copy link

The README currently describes the the two different usage of Git context and Path context..

however it doesn't clearly / explicitly explain that the default behavior is to checkout the repository at the current github ref (based on the event that triggered the action) and use that to build the image.

meaing that any file mutation / creation / updates to the repo in steps that preceed the build step are completely lost and ignored by the build action despite using the github/checkout action in previous steps.

I'd argue this is not a clear and obvious default for the average user who at first glance by looking at the README file, AND given the reset of the GitHub Actions ecosystem defaults ...

if changing the default behaviour is too big of a change, then at least consider updating the docs to explicitly state this and indicate the need to set the context and file arguments as well as the github/checkout step.

I would even include examples in the README of content modification in the repo before the build step.

thanks

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

Successfully merging a pull request may close this issue.

2 participants