feat: added support for dirty files #368
Conversation
docs/reference/config.md
Outdated
| # Defines a list of files that uplift will ignore when checking the | ||
| # status of the current repository. If a change is detected that is | ||
| # not defined in this list, uplift will assume its default behaviour | ||
| # and fail due to the repository being in a dirty state | ||
| dirtyFiles: |
There was a problem hiding this comment.
I've generally found this change hard to understand from the naming and documentation. The text does not really tell me what happens with the 'dirtyFiles' are they only ignored or are they staged / committed by uplift. My assumption is that you want the Uplift to stage the files otherwise you could just add them to the .gitignore file? I feel the name of this config should describe what you want uplift to do with them. So if completely ignoring then maybe ignoreFiles, if staging then maybe stageFiles or addFiles or includeArtifacts (thinking build artifacts that you want in a 'release').
There was a problem hiding this comment.
I like the name includeArtifacts - renaming it
docs/reference/config.md
Outdated
| # Allowing specific case sensitive files to allow using uplift to | ||
| # add unedited but changed files as part of your CI |
There was a problem hiding this comment.
I don't think this is clear enough what the feature does, maybe an example of why it would be useful?
I also think we should update faq/gitdirty.md with how this feature can help.
docs/reference/config.md
Outdated
| # not defined in this list, uplift will assume its default behaviour | ||
| # and fail due to the repository being in a dirty state | ||
| dirtyFiles: | ||
| - file.txt |
There was a problem hiding this comment.
Should we allow Glob patterns? Can this be added later without breaking compatibility?
There was a problem hiding this comment.
I wouldnt like to introduce Glob patterns - only explicit files should only be allowed so users are aware of any extra files which shouldnt have changed
docs/reference/config.md
Outdated
| # status of the current repository. If a change is detected that is | ||
| # not defined in this list, uplift will assume its default behaviour | ||
| # and fail due to the repository being in a dirty state |
There was a problem hiding this comment.
What about rewording to indicate why you would use this:
A list of case sensitive files that will be committed to the repo when the release is created. Typically these files are managed as part of the release process e.g. generated by `hooks`. This allows additional information to be included in a release such as a Software Bill Of Materials (SBOM) that is created by an external tool. There was a problem hiding this comment.
Thanks - documentation is tough :D
docs/faq/gitdirty.md
Outdated
| An example usecase is if a file has been generated as part of your release e.g. software bill of materials which you wish to include in your versioning. | ||
|
|
||
| ```yaml | ||
| Git: |
There was a problem hiding this comment.
Not sure if case sensitive, but to follow other docs this should have a lowercase 'g'
No description provided.