feat: Add working-directory alias for work-dir input #1352
Conversation
This commit adds working-directory as an alias for the existing work-dir input parameter. This enhancement improves compatibility with other GitHub Actions that commonly use working-directory as the standard parameter name.
- Add working-directory alias documentation in Configuration section\n- Add working-directory alias information to v6 migration notes\n- Maintain consistent formatting
n0mer
force-pushed
the
feat/working-directory-alias
branch
from
0e0ba51 to
3b88460
Compare
| @@ -21,6 +21,10 @@ inputs: | |||
| description: 'Location of your Pulumi files. Defaults to ./' | |||
| required: false | |||
| default: ./ | |||
There was a problem hiding this comment.
Don't we need to remove this default otherwise getInput will always get this default value?
There was a problem hiding this comment.
It seems so, yeah.
It might be better to remove the default on work-dir.
Following that change, we can deprecate work-dir but keep it as an alias to working-directory for backwards compatibility.
| @@ -21,6 +21,10 @@ inputs: | |||
| description: 'Location of your Pulumi files. Defaults to ./' | |||
| required: false | |||
| default: ./ | |||
There was a problem hiding this comment.
It seems so, yeah.
It might be better to remove the default on work-dir.
Following that change, we can deprecate work-dir but keep it as an alias to working-directory for backwards compatibility.
| expect(c.workDir).toBe('/custom/path'); | ||
| }); | ||
|
|
||
| it('should prefer work-dir over working-directory when both are provided', async () => { |
There was a problem hiding this comment.
I think it's more transparent for the consumers if the user cannot use both. For example, we can throw an error if the user supplies both.
What do you think?
Add working-directory as an alias for work-dir input to improve compatibility with other GitHub Actions.