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

storage/github: add commit_message_suffix as config entry #154

Merged
merged 1 commit into from Mar 26, 2023

Conversation

parkr
Copy link
Contributor

@parkr parkr commented Aug 2, 2022

Adding '[ci skip]' made sense in the original implementation, when CI
was not often used to act on a status repo. In the age of GitHub
Actions, it would be helpful to be able to control whether this string
is appended.

The current implementation gives the user the choice to append it by
setting the "commit_message_suffix": "[ci skip]" field to their
configuration, but leaves it off by default.

@titpetric
Copy link
Contributor

@beyang at some point I signed a CLA, do we need to do the same for @parkr or would the DCO be implicit? I'm happy to merge this.

@titpetric
Copy link
Contributor

@parkr small ask - if the new config field is empty, it should fall back to [ci skip] internally. It avoids breaking this for people if they upgrade, as they don't need to update the config.

Adding '[ci skip]' made sense in the original implementation, when CI
was not often used to act on a status repo. In the age of GitHub
Actions, it would be helpful to be able to control whether this string
is appended.

The current implementation leaves "[ci skip]" enabled for all users,
and the user can optionally change it by adding this setting to their
storage configuration:

	"commit_message_suffix": "user-defined-string"

If the user sets the suffix to a single space (" "), then it will be
disabled.
@parkr parkr force-pushed the configurable-github-commit-message branch from b28c931 to 798aabd Compare August 30, 2022 16:04
@parkr
Copy link
Contributor Author

parkr commented Aug 30, 2022

@parkr small ask - if the new config field is empty, it should fall back to [ci skip] internally. It avoids breaking this for people if they upgrade, as they don't need to update the config.

Updated. If a user wants it blank, they need to set to " " (a single space).

@beyang beyang merged commit faa9359 into sourcegraph:master Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants