Wrong documentation for v1.1 about create-envfile HOT 5 CLOSED

@riboney I saw the commit on your project, maybe I should have written the issue better.
The github_workspace parameter is only needed if you use the v1.1, instead if you use the master version you can omit that parameter, see examples below:

Using v1.1

- name: Make envfile
      uses: SpicyPizza/[email protected]
      with:
        envkey_SOME_VARIABLE: "test"
        directory: somedirectory
        github_workspace: ${{ github.workspace }} # <-- this is needed in v.1.1

Using master

- name: Make envfile
      uses: SpicyPizza/create-envfile@master
      with:
        envkey_SOME_VARIABLE: "test"
        directory: somedirectory
        # here in master the github_workspace is not needed anymore

Now it should be clearer

from create-envfile.

@Hecsall Thank you so much! 💯

from create-envfile.

Awesome, thanks for the fix

from create-envfile.

@riboney In case you were interested, I believe best practice suggests not referencing @master in the README. Rather, it should reference the latest version/tag or upcoming version/tag. Then, for example, the version of README for tag v1.0 would show [email protected] and the version of README for tag v1.1 would show [email protected]

You can see an example of this approach for tags v0 and v1 of setup-sam.

from create-envfile.

I think this should be resolved properly on 1.3 that is about to come out, so I'm going to close this for now. I'm going to make the docs point to 1.3 specifically, so people should be fine to just use it as the latest.

Feel free to check that the tests cover this case. Also, if there is outstanding changes that should be made, feel free to re-open this issue :)

from create-envfile.