refactor: replace hardcoded URLs etc. with dynamic placeholders for improved configurability #49
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
|
|
||
| def fetchContributors = tasks.register("fetchContributors", contributor.ContributorTask) { | ||
| repoOwner.convention(providers.gradleProperty('githubOrg')) | ||
| repoName.convention(providers.gradleProperty('githubProject')) | ||
| githubToken.convention(providers.environmentVariable('GITHUB_TOKEN')) | ||
| yamlOutput.convention(layout.buildDirectory.file("generated/contributors.yml")) | ||
| } | ||
|
|
||
| extensions.add("contributorsData", fetchContributors.flatMap { it.contributors }) | ||
|
There was a problem hiding this comment. Flatmap is non-lazy so you're invoking the task here. We typically avoid this as it's going to happen as part of the configuration workflow. Some possible workarounds:
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package contributor | ||
|
|
||
| import groovy.json.JsonOutput | ||
| import groovy.json.JsonSlurper | ||
| import groovy.yaml.YamlBuilder | ||
| import groovy.yaml.YamlSlurper | ||
|
|
||
| import org.gradle.api.DefaultTask | ||
| import org.gradle.api.file.RegularFileProperty | ||
| import org.gradle.api.provider.Property | ||
| import org.gradle.api.provider.Provider | ||
| import org.gradle.api.tasks.Input | ||
| import org.gradle.api.tasks.Internal | ||
| import org.gradle.api.tasks.Optional | ||
| import org.gradle.api.tasks.OutputFile | ||
| import org.gradle.api.tasks.TaskAction | ||
|
|
||
| abstract class ContributorTask extends DefaultTask { | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| @Input | ||
| abstract Property<String> getRepoOwner() | ||
|
|
||
| @Input | ||
| abstract Property<String> getRepoName() | ||
|
|
||
| @Input | ||
| @Optional | ||
| abstract Property<String> getGithubToken() | ||
|
|
||
| @OutputFile | ||
| abstract RegularFileProperty getYamlOutput() | ||
|
|
||
| @Internal | ||
| Provider<Map<String, String>> getContributors() { | ||
| yamlOutput.map { regularFile -> | ||
| def yamlFile = regularFile.asFile | ||
| if (!yamlFile.exists()) return Collections.<String, String>emptyMap() | ||
| def yaml = new YamlSlurper().parse(yamlFile) as Map<String, Serializable> | ||
| (yaml.contributors ?: [:]) as Map<String, String> | ||
| } | ||
| } | ||
|
|
||
| @TaskAction | ||
| void generate() { | ||
| def token = githubToken.orNull | ||
| def outputFile = yamlOutput.get().asFile | ||
| outputFile.parentFile.mkdirs() | ||
|
|
||
| if (!token) { | ||
|
There was a problem hiding this comment. You're assuming Github token access to have a reproducible build. We typically don't do this as part of the grails builds. |
||
| logger.warn("No GITHUB_TOKEN — skipping contributor fetch for ${repoOwner.get()}/${repoName.get()}") | ||
| YamlBuilder emptyYaml = new YamlBuilder() | ||
| emptyYaml contributors: [:] | ||
| outputFile.text = emptyYaml.toString() | ||
| return | ||
| } | ||
|
|
||
| // 1. Fetch from REST (sorted by contributions, bots excluded) | ||
| def restUrl = "https://api.github.com/repos/${repoOwner.get()}/${repoName.get()}/contributors" | ||
| def contributors = new JsonSlurper().parseText( | ||
| restUrl.toURL().getText(requestProperties: [Authorization: "token $token"]) | ||
| ).findAll { it.type != 'Bot' } as List<Map<String, Serializable>> | ||
|
|
||
| def sortedNodes = contributors*.node_id | ||
| def loginMap = contributors.collectEntries { [it.node_id, it.login] } as Map<String, String> | ||
|
|
||
| // 2. Fetch display names via GraphQL | ||
| def gqlQuery = 'query($ids: [ID!]!) { nodes(ids: $ids) { ... on User { id name login } } }' | ||
| def body = JsonOutput.toJson([query: gqlQuery, variables: [ids: sortedNodes]]) | ||
|
|
||
| def connection = "https://api.github.com/graphql".toURL().openConnection() as HttpURLConnection | ||
| connection.with { | ||
| doOutput = true | ||
| requestMethod = 'POST' | ||
| setRequestProperty('Authorization', "bearer $token") | ||
| outputStream.withWriter { it << body } | ||
| } | ||
|
|
||
| def gqlResponse = new JsonSlurper().parseText(connection.inputStream.text) | ||
| def nameLookup = gqlResponse.data.nodes.collectEntries { [it.id, it.name ?: it.login] } as Map<String, String> | ||
|
|
||
| // 3. Write YAML output (login → display name, preserving contribution order) | ||
| def finalMap = sortedNodes | ||
| .findAll { loginMap[it] } | ||
| .collectEntries { id -> [loginMap[id], nameLookup[id] ?: loginMap[id]] } as Map<String, String> | ||
|
|
||
| YamlBuilder yaml = new YamlBuilder() | ||
| yaml contributors: finalMap | ||
| outputFile.text = yaml.toString() | ||
| } | ||
| } | ||
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,11 @@ | ||
| import org.gradle.api.publish.maven.tasks.GenerateMavenPom | ||
|
|
||
| plugins { | ||
| id 'config.compile' | ||
| id 'config.grails-plugin' | ||
| id 'config.publish' | ||
| id 'config.testing' | ||
| id 'config.contributors' | ||
| } | ||
|
|
||
| version = projectVersion | ||
|
|
@@ -37,28 +40,28 @@ dependencies { | |
|
|
||
| extensions.configure(org.apache.grails.gradle.publish.GrailsPublishExtension) { | ||
| it.artifactId = project.name | ||
| it.githubSlug = "${githubOrg}/${githubProject}" | ||
|
There was a problem hiding this comment. I don't think you even need to define some of these if you define the properties by default. the publish plugin by default looks for properties |
||
| it.license.name = 'Apache-2.0' | ||
| it.title = "${projectTitle}" | ||
| it.desc = "${projectDescription}" | ||
| it.organization { | ||
| it.name = "${projectOrg}" | ||
| it.url = "https://github.com/${githubOrg}" | ||
| } | ||
| } | ||
|
|
||
| pluginManager.withPlugin('maven-publish') { | ||
|
There was a problem hiding this comment. This isn't the right way to do this - the publish plugin already supports handling this information (https://github.com/apache/grails-gradle-publish/blob/d6951fd43f742c7887e9726435607d1663b60f3c/plugin/src/main/groovy/org/apache/grails/gradle/publish/GrailsPublishExtension.groovy#L77) |
||
| tasks.withType(GenerateMavenPom).configureEach { pomTask -> | ||
| dependsOn(tasks.named('fetchContributors')) | ||
| doFirst { | ||
| pomTask.pom.developers { spec -> | ||
| contributorsData.get().each { String login, String displayName -> | ||
| spec.developer { | ||
| id = login | ||
| name = displayName | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original reason I didn't add a fetch in core, and the other areas is b/c it's not accurate without a malimap. I think for plugins this is probably ok though.