jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding docs for customer commit messages (#212)

Browse Source 
* Adding docs for customer commit messages

* Clean up docs

* Undoes the sidebar changes
* Removes the new doc
* Adds the small section about custom commits to the existing org service doc

* Undo accidental sidebar delete

---------

Co-authored-by: Mike Solomon <mike-solomon@users.noreply.github.com>
This commit is contained in:
Leanne Kerford
2025-03-28 09:28:18 -07:00
committed by GitHub
parent ec074dabdd
commit 94168d4c7d
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/administrator-documentation/moderne-platform/how-to-guides/organizations-service.md
View File

@@ -13,7 +13,7 @@ Let's walk through everything you need to know about both of these options.
While both options offer you the ability to control an organizational structure, there are advantages/disadvantages to each.
Running an Organization service allows for more flexibility when setting up the required GraphQL and REST endpoint. On the other hand, providing the agent with the files requires less setup at the cost of limited flexibility.
Running an Organization service allows for more flexibility when setting up the required GraphQL and REST endpoint. For instance, you can configure custom commit messages, so you can automate tasks like adding a JIRA ticket to a commit message. On the other hand, providing the agent with the files requires less setup at the cost of limited flexibility. It's much quicker and simpler to get started.
Because of that, **we'd recommend the file-based approach** unless you have a compelling reason to not do that.
@@ -54,6 +54,20 @@ How you deploy the service is largely up to your company. With that being said,
* Moderne will make a request per repository to the Organizations service once every 10 minutes by default (you can change this interval in your [agent configuration](./agent-configuration/configure-organizations-service.md)). Please ensure that you have metrics to track how this service is performing so you can adjust it over time.
* You'll want a minimum system spec of 2 CPU cores, 8 GB of memory, and at least 10 GB of persistent storage.
### Configuring custom commit messages
By default, when a user creates a commit in the Moderne Platform, the commit message they provide is the one that is used. However, there are some instances where you may not want this. For example, maybe you want to apply a transformation to the existing message to retrieve a JIRA ticket and add it into the commit message.
To do this, you will need to add custom logic to the [commitMessage query](https://github.com/moderneinc/moderne-organizations/blob/fbc92af9e31076c6dea95499517f7f4e53fdc33c/src/main/java/io/moderne/organizations/OrganizationDataFetcher.java#L47). This query expects a `message` and an `extendedMessage`. If this commit will be used to create a PR, the `message` will be the title of the PR and the body will be the `extendedMessage`.
For example, if your `message` is: `Purr-fect fix: Cat avatars now display correctly` and your `extendedMessage` is: `Resolved issue where cat avatars were displaying upside down.` – then your commit will look like:
```text
Purr-fect fix: Cat avatars now display correctly
Resolved issue where cat avatars were displaying upside down.
```
## Organizations service FAQ
### If the Organizations service stops responding (e.g., the service is down), what is the expected behavior?