Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 3.77 KB

README.md

File metadata and controls

74 lines (60 loc) · 3.77 KB
Raw

Organizations service for the Moderne platform

This repository template is a service that can be run by Moderne customers to inform the platform about the organizational structure of their repositories. In the reference implementation provided here, the organizations are determined by a hardcoded JSON file plus an "ALL" group that contains all repositories. This is meant to be customized per organization.

The GraphQL schema for this service is defined in moderne-organizations.graphqls, and serves as the contract for what Moderne expects a customized organization service to provide.

If there is no organization service configured for your agent, Moderne will fall back on a single shared "ALL" named repository group. This is convenient for onboarding initially, but as a customer grows and brings more teams onto the platform, they should supply organizational hierarchy to help developers action only their assets.

Getting started

  1. Either fork this repository or create a new repository using this as a template.
  2. Clone the repository locally.
  3. Run ./gradlew bootRun to start the service locally.
  4. Go to http://localhost:8080/graphiql to explore the GraphQL API.
  5. Run the following GraphQL command to test the service:
query testOrgService {
  organizations(
    repository: {origin: "github.com", path: "openrewrite/rewrite", branch: "main"}
  ) {
    ...Org
  }
  userOrganizations(user: {email: "example@foo.com"}) {
    ...Org
    parent {
      ...Org
    }
  }
}

fragment Org on Organization {
  id
  name
  commitOptions
}

Customizing the service

Creating organizations

The easiest way to create an organization is to use the Moderne platform to create a repository group and then export it. This will result in a JSON file that you can either use to replace the ownership.json file with or use to create a separate JSON file to have multiple organizations.

If you create a new JSON file, you'll need to update the OrganizationDataFetcher.java file to add a new List<OrganizationRepositories> and concatenate it with the existing ownership list.

Commit options

The commitOptions field on the Organization type is a list of strings that represent the commit options that are available to developers in that organization. These are the options that are presented to developers when they create a commit through the Moderne platform. The options are defined in the CommitOption enum in moderne-organizations.graphqls.

CommitOption explained

Name Description
Direct The commit will be pushed directly to the repository.
Branch The commit will be pushed to a branch.
Fork The commit will be pushed to a fork of the repository.
PullRequest The commit will be pushed to a pull request.
ForkAndPullRequest The commit will be pushed to a fork of the repository and a pull request will be opened.

Organization hierarchy

The parent field on the Organization type is a reference to the parent organization. This is how you define the hierarchy of organizations in your company. The root organization should have a null parent.