यस लेखमा, म Gradle बिल्डर प्रयोग गरेर Sonatype Maven केन्द्रीय भण्डारमा Github कार्यहरू मार्फत स्क्र्याचबाट जाभा कलाकृति प्रकाशित गर्ने प्रक्रियामा विस्तृत रूपमा हेर्न चाहन्छु।

एकै ठाउँमा सामान्य ट्यूटोरियलको कमीको कारण मैले यो लेख लेख्ने निर्णय गरें। सबै जानकारीहरू विभिन्न स्रोतहरूबाट टुक्रा टुक्रा सङ्कलन गर्नुपर्थ्यो, यसबाहेक, पूर्ण रूपमा ताजा छैन। कसलाई ख्याल छ, बिरालो अन्तर्गत स्वागत छ।

Sonatype मा एक भण्डार सिर्जना गर्दै

पहिलो चरण सोनाटाइप माभेन सेन्ट्रलमा भण्डार सिर्जना गर्नु हो। यसका लागि हामी जान्छौं यहाँ, दर्ता गर्नुहोस् र एउटा नयाँ कार्य सिर्जना गर्नुहोस्, हामीलाई भण्डार सिर्जना गर्न सोध्नुहोस्। हामी हाम्रो मा ड्राइभ गर्छौं समूहआईडी परियोजना, परियोजना यूआरएल परियोजना लिङ्क र SCM url संस्करण नियन्त्रण प्रणालीको लिङ्क जसमा परियोजना अवस्थित छ। समूहआईडी यहाँ फारम com.example, com.example.domain, com.example.testsupport हुनुपर्छ, र तपाईंको github को लिङ्कको रूपमा पनि हुन सक्छ: github.com/yourusername -> io.github.yourusername। कुनै पनि अवस्थामा, तपाईंले यो डोमेन वा प्रोफाइलको स्वामित्व प्रमाणित गर्न आवश्यक हुनेछ। यदि तपाईंले github प्रोफाइल निर्दिष्ट गर्नुभयो भने, तपाईंलाई इच्छित नामको साथ सार्वजनिक भण्डार सिर्जना गर्न सोधिनेछ।

पुष्टिकरण पछि केहि समय पछि, तपाइँको GroupId सिर्जना गरिनेछ र हामी अर्को चरण, Gradle कन्फिगरेसनमा जान सक्छौं।

Gradle कन्फिगर गर्दै

लेख्ने समयमा, मैले कलाकृति प्रकाशित गर्न मद्दत गर्न सक्ने Gradle प्लगइनहरू फेला पारेन। यो मैले फेला पारेको एक मात्र प्लगइन, तथापि, लेखकले यसलाई थप समर्थन गर्न अस्वीकार गरे। त्यसकारण, मैले सबै कुरा आफैं गर्ने निर्णय गरें, किनकि यो गर्न गाह्रो छैन।

पत्ता लगाउने पहिलो कुरा भनेको प्रकाशनको लागि सोनाटाइपको आवश्यकताहरू हो। तिनीहरू निम्न हुन्:

स्रोत कोड र JavaDoc को उपलब्धता, अर्थात्। उपस्थित हुनुपर्छ -sources.jar и-javadoc.jar फाइलहरू। कागजातमा उल्लेख गरिए अनुसार, यदि स्रोत कोड वा कागजातहरू उपलब्ध गराउन सम्भव छैन भने, तपाईंले डमी बनाउन सक्नुहुन्छ। -sources.jar वा -javadoc.jar एक साधारण README भित्र परीक्षा पास गर्न को लागी।
सबै फाइलहरू हस्ताक्षर हुनुपर्छ GPG/PGPर .asc हस्ताक्षर भएको फाइल प्रत्येक फाइलको लागि समावेश हुनुपर्छ।
उपलब्धता pom फाइल
सही मानहरू groupId, artifactId и version। संस्करण एक स्वैच्छिक स्ट्रिङ हुन सक्छ र यसको साथ समाप्त हुन सक्दैन -SNAPSHOT
उपस्थिति आवश्यक छ name, description и url
इजाजतपत्र, विकासकर्ता र संस्करण नियन्त्रण प्रणाली बारे जानकारी को उपस्थिति

यी आधारभूत नियमहरू हुन् जुन प्रकाशन गर्दा पालना गर्नुपर्छ। पूर्ण जानकारी उपलब्ध छ यहाँ.

हामी यी आवश्यकताहरू लागू गर्दछौं build.gradle फाइल। पहिले, विकासकर्ताहरू, इजाजतपत्रहरू, संस्करण नियन्त्रण प्रणालीको बारेमा सबै आवश्यक जानकारी थपौं, र परियोजनाको url, नाम र विवरण पनि सेट गरौं। यसको लागि एउटा सरल विधि लेखौं:

def customizePom(pom) {
    pom.withXml {
        def root = asNode()

        root.dependencies.removeAll { dep ->
            dep.scope == "test"
        }

        root.children().last() + {
            resolveStrategy = DELEGATE_FIRST

            description 'Some description of artifact'
            name 'Artifct name'
            url 'https://github.com/login/projectname'
            organization {
                name 'com.github.login'
                url 'https://github.com/login'
            }
            issueManagement {
                system 'GitHub'
                url 'https://github.com/login/projectname/issues'
            }
            licenses {
                license {
                    name 'The Apache License, Version 2.0'
                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                }
            }
            scm {
                url 'https://github.com/login/projectname'
                connection 'scm:https://github.com/login/projectname.git'
                developerConnection 'scm:git://github.com/login/projectname.git'
            }
            developers {
                developer {
                    id 'dev'
                    name 'DevName'
                    email '[email protected]'
                }
            }
        }
    }
}

अर्को, तपाईंले उत्पन्न विधानसभा समयमा निर्दिष्ट गर्न आवश्यक छ -sources.jar и-javadoc.jar फाइलहरू। यस खण्डको लागि java तपाईंले निम्न थप्न आवश्यक छ:

java {
    withJavadocJar()
    withSourcesJar()
}

GPG/PGP हस्ताक्षर सेटअप गर्दै अन्तिम आवश्यकतामा जाऔं। यो गर्नको लागि, प्लगइन जडान गर्नुहोस् signing:

plugins {
    id 'signing'
}

र एउटा खण्ड थप्नुहोस्:

signing {
    sign publishing.publications
}

अन्तमा, एउटा खण्ड थपौं publishing:

publishing {
    publications {
        mavenJava(MavenPublication) {
            customizePom(pom)
            groupId group
            artifactId archivesBaseName
            version version

            from components.java
        }
    }
    repositories {
        maven {
            url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
            credentials {
                username sonatypeUsername
                password sonatypePassword
            }
        }
    }
}

यो छ sonatypeप्रयोगकर्ता नाम и sonatypePassword दर्ताको क्रममा सिर्जना गरिएको लगइन र पासवर्ड समावेश चर sonatype.org.

यसरी फाइनल build.gradle यस्तो देखिनेछ:

पूर्ण build.gradle कोड

plugins {
    id 'java'
    id 'maven-publish'
    id 'signing'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
    withJavadocJar()
    withSourcesJar()
}

group 'io.github.githublogin'
archivesBaseName = 'projectname'
version = System.getenv('RELEASE_VERSION') ?: "0.0.1"

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.2'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.5.2'
}

test {
    useJUnitPlatform()
}

jar {
    from sourceSets.main.output
    from sourceSets.main.allJava
}

signing {
    sign publishing.publications
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            customizePom(pom)
            groupId group
            artifactId archivesBaseName
            version version

            from components.java
        }
    }
    repositories {
        maven {
            url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
            credentials {
                username sonatypeUsername
                password sonatypePassword
            }
        }
    }
}

def customizePom(pom) {
    pom.withXml {
        def root = asNode()

        root.dependencies.removeAll { dep ->
            dep.scope == "test"
        }

        root.children().last() + {
            resolveStrategy = DELEGATE_FIRST

            description 'Some description of artifact'
            name 'Artifct name'
            url 'https://github.com/login/projectname'
            organization {
                name 'com.github.login'
                url 'https://github.com/githublogin'
            }
            issueManagement {
                system 'GitHub'
                url 'https://github.com/githublogin/projectname/issues'
            }
            licenses {
                license {
                    name 'The Apache License, Version 2.0'
                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                }
            }
            scm {
                url 'https://github.com/githublogin/projectname'
                connection 'scm:https://github.com/githublogin/projectname.git'
                developerConnection 'scm:git://github.com/githublogin/projectname.git'
            }
            developers {
                developer {
                    id 'dev'
                    name 'DevName'
                    email '[email protected]'
                }
            }
        }
    }
}

म नोट गर्न चाहन्छु कि हामीले वातावरण चरबाट संस्करण प्राप्त गर्छौं: System.getenv('RELEASE_VERSION')। हामी यसलाई सभाको समयमा उजागर गर्नेछौं र यसलाई ट्याग नामबाट लिनेछौं।

PGP कुञ्जी पुस्ता

Sonatype को आवश्यकताहरू मध्ये एक भनेको सबै फाइलहरू GPG/PGP कुञ्जीद्वारा हस्ताक्षरित हुनुपर्छ। यसका लागि हामी जान्छौं यहाँ र आफ्नो अपरेटिङ सिस्टमको लागि GnuPG उपयोगिता डाउनलोड गर्नुहोस्।

हामी कुञ्जी जोडा उत्पन्न गर्छौं: gpg --gen-key, प्रयोगकर्ता नाम, इ-मेल प्रविष्ट गर्नुहोस्, र पासवर्ड पनि सेट गर्नुहोस्।
हामी पत्ता लगाउँछौं id आदेश संग हाम्रो कुञ्जी: gpg --list-secret-keys --keyid-format short। आईडी स्ल्याश पछि निर्दिष्ट गरिनेछ, उदाहरण को लागी: rsa2048/9B695056
सर्भरमा सार्वजनिक कुञ्जी प्रकाशित गर्दै https://keys.openpgp.org आदेश: gpg --keyserver [https://keys.openpgp.org](https://keys.openpgp.org/) --send-keys 9B695056
हामी गोप्य कुञ्जीलाई मनमानी ठाउँमा निर्यात गर्छौं, हामीलाई भविष्यमा यसको आवश्यकता हुनेछ: gpg --export-secret-key 9B695056 > D:\gpg\9B695056.gpg

Github कार्यहरू सेट अप गर्दै

अन्तिम चरणमा जानुहोस्, Github कार्यहरू प्रयोग गरेर निर्माण र स्वत: प्रकाशन सेट अप गर्नुहोस्।
Github कार्यहरू एक सुविधा हो जसले तपाईंलाई पूर्ण CI / CD चक्र लागू गरेर कार्यप्रवाह स्वचालित गर्न अनुमति दिन्छ। निर्माण, परीक्षण, र तैनाती विभिन्न घटनाहरूद्वारा ट्रिगर गर्न सकिन्छ: कोड पुश, रिलीज सिर्जना, वा मुद्दाहरू। यो कार्यक्षमता सार्वजनिक भण्डारहरूको लागि बिल्कुल निःशुल्क छ।

यस खण्डमा, म तपाईंलाई कसरी बिल्ड र पुश कोड सेटअप गर्ने र रिलीजमा सोनाटाइप भण्डारमा डिप्लोय गर्ने, साथै गोप्यहरू सेटअप गर्ने भनेर देखाउनेछु।

हामीले गोप्य राख्यौं

स्वचालित असेम्ब्ली र डिप्लोइमेन्टका लागि, हामीलाई धेरै गोप्य मानहरू चाहिन्छ, जस्तै कि कुञ्जी आईडी, कुञ्जी उत्पन्न गर्दा हामीले प्रविष्ट गरेको पासवर्ड, PGP कुञ्जी आफैं, र Sonatype लगइन/पासवर्ड। तपाइँ तिनीहरूलाई भण्डार सेटिङहरूमा विशेष खण्डमा सेट गर्न सक्नुहुन्छ:

हामीले निम्न चरहरू सेट गर्छौं:

SONATYPE_USERNAME / SONATYPE_PASSWORD - लगइन / पासवर्ड जुन हामीले Sonatype मा दर्ता गर्दा प्रविष्ट गरेका थियौं
SIGNING_KEYID/SIGNING_PASSWORD — PGP कुञ्जी आईडी र पासवर्ड जेनेरेशनको समयमा सेट गरियो।

म थप विवरणमा GPG_KEY_CONTENTS चरमा बस्न चाहन्छु। तथ्य यो हो कि प्रकाशनको लागि हामीलाई निजी PGP कुञ्जी चाहिन्छ। गोप्य मा पोस्ट गर्न को लागी, मैले प्रयोग गरें निर्देशन र साथै धेरै कार्यहरू गरे।

Gpg को साथ हाम्रो कुञ्जी इन्क्रिप्ट गरौं: gpg --symmetric --cipher-algo AES256 9B695056.gpgपासवर्ड प्रविष्ट गरेर। यसलाई चलमा राख्नुपर्छ: SECRET_PASSPHRASE
प्राप्त इन्क्रिप्टेड कुञ्जीलाई आधार 64 प्रयोग गरेर पाठ फारममा अनुवाद गरौं: base64 9B695056.gpg.gpg > 9B695056.txt। सामग्री चरमा राखिनेछ: GPG_KEY_CONTENTS।

कोड पुश गर्दा र PR सिर्जना गर्दा सेटअप बनाउनुहोस्

पहिले तपाईंले आफ्नो परियोजनाको मूलमा फोल्डर सिर्जना गर्न आवश्यक छ: .github/workflows.

यसमा, फाइल मार्कअप गर्नुहोस्, उदाहरणका लागि, gradle-ci-build.yml निम्न सामग्री संग:

name: build

on:
  push:
    branches:
      - master
      - dev
      - testing
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Set up JDK 8
        uses: actions/setup-java@v1
        with:
          java-version: 8

      - name: Build with Gradle
        uses: eskatos/gradle-command-action@v1
        with:
          gradle-version: current
          arguments: build -PsonatypeUsername=${{secrets.SONATYPE_USERNAME}} -PsonatypePassword=${{secrets.SONATYPE_PASSWORD}}

यो कार्यप्रवाह शाखाहरूमा पुश गर्दा कार्यान्वयन गरिनेछ master, dev и testing, पुल अनुरोधहरू सिर्जना गर्दा पनि।

रोजगार खण्डले निर्दिष्ट घटनाहरूमा कार्यान्वयन गर्नका लागि चरणहरू निर्दिष्ट गर्दछ। यस अवस्थामा, हामी ubuntu को नवीनतम संस्करणमा निर्माण गर्नेछौं, Java 8 प्रयोग गर्नेछौं, र Gradle को लागी प्लगइन पनि प्रयोग गर्नेछौं। eskatos/gradle-command-action@v1जसले, निर्माणकर्ताको नवीनतम संस्करण प्रयोग गरेर, मा निर्दिष्ट आदेशहरू चलाउनेछ arguments। चरहरू secrets.SONATYPE_USERNAME и secrets.SONATYPE_PASSWORD यी हामीले पहिले सोधेका रहस्यहरू हुन्।

निर्माण परिणामहरू कार्य ट्याबमा प्रतिबिम्बित हुनेछन्:

नयाँ रिलीज रिलीज हुँदा स्वत: डिप्लोइ

Autodeploy को लागी एक अलग कार्यप्रवाह फाइल सिर्जना गरौं gradle-ci-publish.yml:

name: publish

on:
  push:
    tags:
      - 'v*'

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Set up JDK 8
        uses: actions/setup-java@v1
        with:
          java-version: 8

      - name: Prepare to publish
        run: |
          echo '${{secrets.GPG_KEY_CONTENTS}}' | base64 -d > publish_key.gpg
          gpg --quiet --batch --yes --decrypt --passphrase="${{secrets.SECRET_PASSPHRASE}}" 
          --output secret.gpg publish_key.gpg
          echo "::set-env name=RELEASE_VERSION::${GITHUB_REF:11}"

      - name: Publish with Gradle
        uses: eskatos/gradle-command-action@v1
        with:
          gradle-version: current
          arguments: test publish -Psigning.secretKeyRingFile=secret.gpg -Psigning.keyId=${{secrets.SIGNING_KEYID}} -Psigning.password=${{secrets.SIGNING_PASSWORD}} -PsonatypeUsername=${{secrets.SONATYPE_USERNAME}} -PsonatypePassword=${{secrets.SONATYPE_PASSWORD}}

फाइल पहिलेको जस्तै लगभग समान छ, घटना बाहेक जुन यो ट्रिगर हुनेछ। यस अवस्थामा, यो v बाट सुरु हुने नामको साथ ट्याग सिर्जना गर्ने घटना हो।

डिप्लोइमेन्ट गर्नु अघि, हामीले गोप्यबाट PGP कुञ्जी निकाल्नु पर्छ र यसलाई प्रोजेक्टको रूटमा राख्नु पर्छ, साथै यसलाई डिक्रिप्ट गर्नुपर्छ। अर्को, हामीले एक विशेष वातावरण चर सेट गर्न आवश्यक छ RELEASE_VERSION जसलाई हामीले उल्लेख गर्छौं gradle.build फाइल। यो सबै खण्ड मा गरिन्छ Prepare to publish। हामीले हाम्रो कुञ्जी GPG_KEY_CONTENTS चरबाट प्राप्त गर्छौं, यसलाई gpg फाइलमा अनुवाद गर्नुहोस्, त्यसपछि फाइलमा राखेर यसलाई डिक्रिप्ट गर्नुहोस्। secret.gpg.

अर्को, हामी एक विशेष चरमा जान्छौं GITHUB_REF, जसबाट हामीले ट्याग सिर्जना गर्दा सेट गरेको संस्करण प्राप्त गर्न सक्छौं। यो चर यस मामला मा सान्दर्भिक छ। refs/tags/v0.0.2 जसबाट हामीले विशेष संस्करण प्राप्त गर्नका लागि पहिलो 11 वर्णहरू काट्यौं। अर्को, हामी प्रकाशनको लागि मानक Gradle आदेशहरू प्रयोग गर्छौं: test publish

Sonatype भण्डारमा परिनियोजन परिणामहरू जाँच गर्दै

रिलीज सिर्जना भएपछि, अघिल्लो खण्डमा वर्णन गरिएको कार्यप्रवाह सुरु हुनुपर्छ। यो गर्नको लागि, रिलीज सिर्जना गर्नुहोस्:

ट्याग नाम v बाट सुरु हुनुपर्छ। यदि, प्रकाशन प्रकाशित क्लिक गरेपछि, कार्यप्रवाह सफलतापूर्वक पूरा भयो, हामी जान सक्छौं Sonatype Nexus सुनिश्चित गर्न:

कलाकृति स्टेजिङ भण्डारमा देखा पर्‍यो। यो तुरुन्तै खुला स्थितिमा देखा पर्दछ, त्यसपछि यसलाई म्यानुअल रूपमा उपयुक्त बटन थिचेर बन्द स्थितिमा स्थानान्तरण गर्नुपर्छ। सबै आवश्यकताहरू पूरा भएको जाँच गरेपछि, कलाकृति बन्द स्थितिमा जान्छ र अब परिमार्जनको लागि उपलब्ध छैन। यस फारममा, यो MavenCentral मा समाप्त हुनेछ। यदि सबै ठीक छ भने, तपाइँ बटन थिच्न सक्नुहुन्छ जारी, र कलाकृति सोनाटाइप भण्डारमा समाप्त हुनेछ।

कलाकृति MavenCentral मा प्राप्त गर्न को लागी, तपाईले यसलाई हामीले सुरुमा सिर्जना गरेको कार्यमा सोध्नु पर्छ। तपाईंले यो एक पटक मात्र गर्न आवश्यक छ, त्यसैले हामी पहिलो पटक प्रकाशित गर्छौं। पछिल्लो समयमा, यो आवश्यक छैन, सबै स्वचालित रूपमा सिंक्रोनाइज हुनेछ। तिनीहरूले मेरो लागि तुरुन्तै सिङ्क्रोनाइजेसन सक्रिय गरे, तर कलाकृति MavenCentral मा उपलब्ध हुन लगभग 5 दिन लाग्यो।

यति मात्रै हो, हामीले हाम्रो कलाकृति MavenCentral मा प्रकाशित गरेका छौं।

उपयोगी लिङ्कहरू

समान लेख, maven मार्फत मात्र प्रकाशित
स्थिरता भण्डार सोनाटाइप
Jira सोनाटाइप जसमा कार्य सिर्जना गर्न
उदाहरण: भण्डार जहाँ यो सबै सेट अप छ

स्रोत: www.habr.com

Sonatype Maven केन्द्रीय भण्डारमा जाभा परियोजना प्रकाशित गर्न Gradle र Github कार्यहरू प्रयोग गर्दै