Add customisation of git messages#192
Closed
ryangittings wants to merge 9 commits intopagescms:developmentfrom
Closed
Add customisation of git messages#192ryangittings wants to merge 9 commits intopagescms:developmentfrom
ryangittings wants to merge 9 commits intopagescms:developmentfrom
Conversation
Contributor
|
hunvreus
requested changes
Mar 17, 2025
| path: string, | ||
| contentBase64: string, | ||
| sha?: string, | ||
| message?: string |
Contributor
There was a problem hiding this comment.
@ryangittings I don't think message is optional.
| import { configVersion, parseConfig, normalizeConfig } from "@/lib/config"; | ||
| import { stringify } from "@/lib/serialization"; | ||
| import { deepMap, getDefaultValue, generateZodSchema, getSchemaByName, sanitizeObject } from "@/lib/schema"; | ||
| import { deepMap, getDefaultValue, generateZodSchema, getSchemaByName, sanitizeObject, generateFromPattern } from "@/lib/schema"; |
Contributor
There was a problem hiding this comment.
Use interpolate(): https://github.com/pages-cms/pages-cms/blob/development/lib/schema.ts#L211
Comment on lines
+56
to
+69
| if (data.sha) { | ||
| message = `Update ${normalizedPath} (via Pages CMS)`; | ||
|
|
||
| if (config.object?.commit?.message?.update) { | ||
| message = generateFromPattern(config.object.commit.message.update, index); | ||
| } | ||
| } else { | ||
| message = `Create ${normalizedPath} (via Pages CMS)`; | ||
|
|
||
| if (config.object?.commit?.message?.create) { | ||
| message = generateFromPattern(config.object.commit.message.create, index); | ||
| } | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
Not a fan of that block. Probably cleaner to do something like:
message = data.sha
? config.object?.commit?.message?.update
? (...)
: (...)
: (...)
? (...)
: (...);
Comment on lines
+303
to
+321
|
|
||
| let message = `File "${normalizedPath}" deleted successfully.`; | ||
|
|
||
| if (config.object?.commit?.message?.delete) { | ||
| const index = { | ||
| filename: getFileName(normalizedPath), | ||
| path: normalizedPath, | ||
| collection: { | ||
| name: name, | ||
| }, | ||
| user: { | ||
| name: user.githubName, | ||
| username: user.githubUsername, | ||
| email: user.githubEmail || user.email | ||
| } | ||
| } | ||
|
|
||
| message = generateFromPattern(config.object.commit.message.delete, index); | ||
| } |
Contributor
There was a problem hiding this comment.
Use interpolate() and use the ternary operator.
components/entry/entry-editor.tsx
Outdated
|
|
||
| const router = useRouter(); | ||
|
|
||
| const { user } = useUser(); |
hunvreus
requested changes
Apr 15, 2025
Contributor
hunvreus
left a comment
hunvreus
left a comment
There was a problem hiding this comment.
- We're only addressing collections here. We should do the same as we do in the backend routes and have a type + name (e.g. collection + posts, file + authors, media + images, settings, ...).
- We're missing renaming operations.
- We need to have logic to have settings that are defined both globally or at the collection/file/media level
| const normalizedPath = normalizePath(params.path); | ||
| let schema; | ||
|
|
||
| const index = { |
Contributor
There was a problem hiding this comment.
Not a fan of that name "index". Maybe "messageData" is better?
Contributor
There was a problem hiding this comment.
This is too focused on collections. We also have files, media and settings.
Contributor
There was a problem hiding this comment.
You missed the rename route.
| } | ||
|
|
||
| const message = config?.object?.commit?.message?.delete | ||
| ? interpolate(config.object.commit.message.delete, index) |
Contributor
There was a problem hiding this comment.
I think we should always try to get the closest settings for that before using the global settings. And that means also looking at file, media and settings.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added new commit config:
And this allows users to customise the commit message. The follow bits of data are supported: