Auto: maven-release-plugin에 대한 요구 사항 제거

완전히 동의 해!

pom.xml에서 얻은 정보가 포함된 대부분의 요점은 아마도 해당 필드에 대한 나의 오해와 관련이 있을 것입니다. 여기에서 어떤 변경도 환영합니다.

저는 우리가 해야 하는 모든 주요 변경 사항에 찬성합니다. #1156에 자세히 설명된 작은 주요 변경 사항 중 일부를 롤링할 수 있습니다.

<scm/> 및 <developers/> 에 대한 두 가지 요점이 잘못된 것 같습니다. npm 플러그인은 package.json 에서 플러그인을 가져옵니다. 이것은 pom.xml _should_ 있어야 함을 의미합니까?

npm repository 및 author 필드에 해당하는 pom 경우 예입니다.

작성자는 다음을 통해 설정됩니다. 이는 커밋을 수행하는 사람이 선택한 작성자와 동일하지 않을 수 있음을 의미합니다. git commit 작성자를 다음과 정렬하려는 시도가 없습니다. 정보.

이것은 npm 플러그인에서도 마찬가지입니다. 로컬에서 auto는 git 구성을 재정의하지 않지만 CI 환경에서는 author 를 커밋`으로 설정해야 할 수 있습니다.

소유자 및 repo 정보는 다음을 통해 설정됩니다. 섹션은 현재 클론의 실제 저장소 및 소유자와 다를 수 있습니다.

이 다를까요? npm 세계에서 repository 필드는 일반적으로 패키지의 코드를 가리킵니다. 연습 하나에서 일반적으로 실행되지 않습니다 auto A의 fork 그들이에 있다면 나는 그들이이 업데이트 희망 repository 자신의 포크에 필드를

알겠습니다. 따라서 적절한 동작은 해당 항목(현재)을 찾는 것이며 pom.xml 에서 찾을 수 없으면 .autorc (새 동작).

는 찾을 수없는 경우 현재 플러그인 오류가 발생하지 <scm/> 및 <developers/> 의 섹션 pom.xml .

아, 확실히 버그입니다. 오류가 발생하지 않아야 합니다. https://github.com/intuit/auto/blob/master/plugins/npm/src/index.ts#L504

기계가 읽을 수 있는 방식으로 auto 에서 버전 NUMBER를 얻는 방법이 있습니까? auto version 명령이 숫자가 아닌 버전 범프의 TYPE을 생성한다는 사실에 놀랐습니다.

--quiet 사용할 수 있으며 명령으로 생성된 버전만 인쇄합니다. 또는 --dry-run 와 페어링하면 다음에 게시될 버전을 볼 수 있습니다.

version 가 실제 버전을 뱉어내도록 플래그를 추가할 수 있습니다. 이것은 다중 패키지 시나리오에서 이상해집니다.

나는 그것을 볼 수 있습니다. 찾고 있는 버전을 파악하기 위해 호출자에게 맡기는 것이 더 나을 것입니다.

다중 패키지 시나리오에 대한 귀하의 요점은 여기에서 적절합니다. maven-release-plugin은 기본적으로 해당 유형의 시나리오를 지원합니다. 이 작품을 재현하고 싶은지 의문이 듭니다. 나는 약간의 교착 상태에 빠져 있습니다. 한편으로는 maven-release-plugin을 사용하지 않는다는 제 주장이 유효하지만, 다른 한편으로는 하위 모듈 버전 관리와 같은 것들은 다음과 같은 사소한 사용 사례입니다. 해결되어야 하며 maven-release-plugin에 의해 다루어집니다.

release:prepare 동안 maven 플러그인이 저장소를 수정하는 것을 방지하는 데 사용할 수 있는 maven-release-plugin을 사용하는 두 가지 방법을 찾았으며 오늘 나중에 테스트할 예정입니다.

@hipstersmoothie getAuthor , getRepo 등 후크 동작에 대한 질문이 있습니다 . - RE:

예시:
https://github.com/intuit/auto/blob/47d3b54ef1a7af990fe0ca898e747dd833fde3b1/plugins/maven/__tests__/maven.test.ts#L95

따라서 undefined AuthorInformation 반환하면 오류가 발생하지 않습니다.

내가 무엇을 잘못하고 있는지 또는 후크 처리에 throw 를 다시 도입해야 하는지에 대한 제안이 있습니까?

다른 모든 플러그인이 작동하는 방식을 고려할 때 이는 확실히 잘못된 것입니다. undefined를 반환하는 것이 올바른 방법입니다. 그렇게 하면 core 는 필요한 경우 로컬로 구성된 git 사용자로 폴백할 수 있습니다.

Gotcha - 그게 내가 생각한 것이므로 실패한 후크가 undefined 반환하도록 테스트를 수정했습니다.

버전을 찾을 수 없으면 gradle 및 cocoapods 플러그인 모두 오류가 발생하는 것 같습니다. gradle 플러그인에 대한 버그를 만들었습니다. cocoapods에 대해 다른 버그를 원하십니까?

문제에 대해 그냥 두지 마십시오. 잡아주셔서 감사합니다!

hooks.beforeRun 동안 값 초기화를 테스트하기 위한 좋은 방법으로 어려움을 겪고 있습니다. 특히 디버그 상태에서 hooks.beforeRun 탭 중에 작성자 정보를 성공적으로 추출하지만 테스트에 실패하는 다음 코드가 있습니다.

    test("should get author from pom.xml", async () => {
      mockRead(`
        <project
          xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
          <developers>
            <developer>
              <name>Andrew Lisowski</name>
              <email>[email protected]</email>
            </developer>
          </developers>
        </project>
      `);

      await hooks.beforeRun.promise({} as any);

      expect(await hooks.getAuthor.promise()).toStrictEqual(
        expect.objectContaining({
          email: "[email protected]",
          name: "Andrew Lisowski",
        })
      );
    });

beforeRun 후크가 실행되기 전에 테스트가 getAuthor 후크에 도달하는 중입니다. 나는 이것을 테스트하는 다른 코드 (gradle, s3)를 보았고 운이 없었습니다.

기본적으로 beforeRun 후크를 결정론적으로 실행하는 방법이 필요하고 수행 방법을 알 수 없습니다.

분기를 푸시하면 확인할 수 있습니다.

@hipstersmoothie 여기 지점이 있습니다: https://github.com/terradatum/auto/tree/remove-maven-release-plugin-requirement

원격 기록을 오염시키지 않고 실제 프로젝트에서 코드를 테스트할 수 있도록 변경 사항을 중앙 저장소로 푸시하는 코드를 주석 처리했습니다.

이에 대해 도움을 주시면 대단히 감사하겠습니다. "코드를 실제 파일을 확인하고, git reset --hard HEAD~1 를 실행하여 변경 사항을 제거하고, 헹구고 반복하십시오."

또한 IntelliJ에서 jest 테스트를 실행하기 위해 루트 package.json 와 호환되지 않는 로컬 package.json 를 일부 변경해야 했습니다. 이에 대해 알려줄 수 있는 지침이 있습니까? 아니면 바로 "작동"해야 합니까?

특히, maven 플러그인 디렉토리에 있고 npm test 를 실행할 때 - "test": "jest --maxWorkers=2 --config ../../package.json" 때문에 모든 테스트가 실행됩니다.

편집기에서 IntelliJ Test Runner를 사용하려고 하면 다음과 같은 결과가 나타납니다.

  ● Test suite failed to run

    SyntaxError: /home/rbellamy/Development/Terradatum/auto/plugins/maven/__tests__/maven.test.ts: Unexpected token, expected "," (15:24)

      13 | }));
      14 | 
    > 15 | const mockRead = (result: string) =>
         |                         ^
      16 |   jest
      17 |     .spyOn(fs, "readFile")
      18 |     // @ts-ignore

      at Parser._raise (../../node_modules/@babel/parser/src/parser/location.js:241:45)
      at Parser._raise [as raiseWithData] (../../node_modules/@babel/parser/src/parser/location.js:236:17)
      at Parser.raiseWithData [as raise] (../../node_modules/@babel/parser/src/parser/location.js:220:17)
      at Parser.raise [as unexpected] (../../node_modules/@babel/parser/src/parser/util.js:149:16)
      at Parser.unexpected [as expect] (../../node_modules/@babel/parser/src/parser/util.js:129:28)
      at Parser.expect [as parseParenAndDistinguishExpression] (../../node_modules/@babel/parser/src/parser/expression.js:1293:14)
      at Parser.parseParenAndDistinguishExpression [as parseExprAtom] (../../node_modules/@babel/parser/src/parser/expression.js:1029:21)
      at Parser.parseExprAtom [as parseExprSubscripts] (../../node_modules/@babel/parser/src/parser/expression.js:539:23)
      at Parser.parseExprSubscripts [as parseMaybeUnary] (../../node_modules/@babel/parser/src/parser/expression.js:519:21)
      at Parser.parseMaybeUnary [as parseExprOps] (../../node_modules/@babel/parser/src/parser/expression.js:311:23)

jest.config.ts 파일을 추가하여 IntelliJ 문제를 해결할 수 있습니다.

module.exports = {
  clearMocks: true,
  moduleFileExtensions: ['js', 'ts'],
  testEnvironment: 'node',
  testMatch: ['**/*.test.ts'],
  testRunner: 'jest-circus/runner',
  transform: {
    '^.+\\.ts$': 'ts-jest'
  },
  verbose: true
}

그리고 추가 jest-circus 루트 또는 받는다는 하나에 package.json 파일.

xml2js 는 XML => JSON => XML 변환 동안 모든 XML 주석을 자동으로 제거하기 때문에 작업을 수행하지 않을 것임을 방금 알아차렸습니다. 나는 그것을 작동시키려고 노력했고, 그것은 이빨을 뽑는 것과 같다. xml2js 변환을 통해 이동할 때 XML이 원본과 유사하게 보일 것이라는 보장은 없으며 이는 거래 차단기입니다.

하나의 플러그인에 대한 테스트를 실행하려면 루트에서 실행합니다.

yarn test plugins/maven

그러면 실제로 변경하지 않고도 만들려는 모든 변경 사항이나 빌드할 아티팩트를 쉽게 표시할 수 있는지 여부에 대한 질문이 생깁니다.

그것은 꽤 큰 문제의 차단기처럼 보입니다. 해당 파일을 편집할 수 있는 Java 환경에 제공되는 표준 CLI가 있습니까?

구성 파일(예: ruby)에 대한 파서가 없는 플러그인의 경우 auto 는 대부분 정규식을 사용하여 파일을 업데이트합니다.

beforeRun 이슈를 볼 기회가 있었나요? 해결 방법이 있지만 정말 해킹 된 것 같습니다 ...

XML과 함께 정규식을 사용하는 아이디어는 정말 싫습니다. XML은 오류가 발생하기 쉽고 부서지기 쉽습니다. 그러나 DOMParser 또는 XMLSerializer 를 사용하여 버전을 수정하는 것도 엄청나게 복잡해 보이기 때문에 처음에는 xml2js 로 작업하려고 했습니다.

지금 이것을보고!

https://github.com/terradatum/auto/blob/remove-maven-release-plugin-requirement/plugins/maven/src/index.ts#L127

문제는 "동기식" 탭을 수행하고 내부에서 비동기 작업을 수행하고 있다는 것입니다.

이것을 변경

auto.hooks.beforeRun.tap(this.name, async () => {

이에

auto.hooks.beforeRun.tapPromise(this.name, async () => {

아 실행 전 후크가 지금 동기화되어있어 그게 진짜 문제입니다. 그가 된 경우는 아무것도 변하지 않을 것 AsyncSeriesHook 대신의 SyncHook . 내가 말하는 것이 명확하지 않은 경우 커밋을 브랜치로 푸시할 수 있습니다.

제발... 내가 당신을 기여자로 만들게 해주세요.

가자!

그냥 밀어. 테스트를 실행했고 지금은 2개만 실패합니다. beforeRun 후크가 예상대로 작동합니다.

@hipstersmoothie terradatum/auto repo에 대한 커밋이 보이지 않습니까?

이제 나는 실제로 밀었다

현재 동기 탭을 사용하고 있는 플러그인에 큰 변화가 있습니까?

아니요. 동기화 탭은 동일하게 작동해야 합니다. 이것은 단지 약속을 탭하는 기능을 추가합니다

깨지기 쉬운/오류가 발생하기 쉬운 정규식으로 이 작업을 성공적으로 수행했습니다. 내 관심사는 <version/> 요소가 pom.xml 파일의 모든 곳에서 - 아티팩트 버전과 종속성 및 플러그인에 대해 사용된다는 것입니다. 즉, 정규식은 의도하지 않은 버전을 실수로 변경할 가능성이 높습니다.

XML DOM(xmldom, xmldom-ts, xml2js, xml2json 등을 통해)으로 작업하려고 할 때 엄청난 규모의 수렁에 빠져 있었습니다. 나는 결코 스스로를 타이프스크립트나 자바스크립트 전문가라고 생각하지 않습니다. 그래서 아마 제가 넘어지고 있는 부분일 것입니다.

두 가지가 내 엉덩이를 걷어차고 있습니다.

1. IntelliJ가 디버그 모드에서 maven 테스트(및 maven 테스트만)를 실행하도록 하는 방법을 알 수 없습니다. 때로는 작동하고 때로는 작동하지 않습니다.
2. pom.xml을 Document 로드한 다음 xpath를 사용하여 "/project/version" 및 "/project/parent/version" 노드를 선택합니다.

그 두 문제 사이에서 나는 아마 총 12~16시간을 보냈을 것이고, 나는 정말로 좌절하고 있습니다. 오늘 아침까지 1번 작업을 하고 있었고 2번은 비교적 단순해야 한다고 생각했는데 매번 저와 싸우는 것 같습니다.

pom.xml 파일 업데이트를 처리하는 엄청나게 간단한 이유 때문에 maven-release-plugin을 다시 사용하는 경향이 있습니다.

IntelliJ가 디버그 모드에서 maven 테스트(및 maven 테스트만)를 실행하도록 하는 방법을 알 수 없습니다. 때로는 작동하고 때로는 작동하지 않습니다.

여기에 도움이 되지 못해서 죄송합니다. 저는 VSCode를 사용하고 테스트를 거의 디버그하지 않습니다. yarn test plugins/maven 루트에서 실행할 수 있습니까?

pom.xml을 문서에 로드한 다음 xpath를 사용하여 "/project/version" 및 "/project/parent/version" 노드를 선택합니다.

이것은 좋은 방법인 것 같습니다. 그것이 효과가 있다면 좋은 것 같습니다.

pom.xml 파일 업데이트를 처리하는 엄청나게 간단한 이유 때문에 maven-release-plugin을 다시 사용하는 경향이 있습니다.

https://stackoverflow.com/questions/5726291/updating-version-numbers-of-modules-in-a-multi-module-maven-project 와 같은 플러그인 기반 항목만 maven에서 사용할 수 있습니까? 낮은 수준의 mvn 기반의 것이 완벽할 것입니다.

BTW 이것에 많은 시간을 할애해 주셔서 감사합니다!

피드백과 지원에 감사드립니다. rant(ish) 이전 댓글에 대해 죄송합니다.

Versions-maven-plugin에 대한 좋은 점 - 이전에 작업한 적이 없고 그것이 존재하는지 전혀 몰랐습니다. 그것은 확실히 나를 더 쉽게 만들 것입니다 ... 그것은 maven-release-plugin과 자동 플러그인을 통해 pom.xml 파일을 관리하려는 것 사이의 완벽한 절충안입니다.

yarn test plugins/maven 을(를) 사용할 수 있습니다. 나는 또한 더 전통적인 console.log 보다는 디버거를 사용하여 물건을 검사하는 것을 좋아합니다. 그래서 그것이 아마도 제가 필요한 것보다 더 가슴 앓이를 일으키는 곳일 것입니다...

길고 힘든 여정 끝에 pom.xml 파일을 직접 수정 하거나 versions-maven-plugin 를 사용하여 버전을 설정하는 완전한 솔루션이 거의 완성되었습니다.

몇 가지 주의사항이 있습니다. pom.xml 를 수정하는 데 사용되는 코드는 DOM과 함께 작동하므로 다음과 같은 결과가 발생합니다.

1. "dom" 라이브러리가 "compilerOptions" "es2017" 앞에 있어야 하는 tsconfig.json 처리에 버그가 있습니다.

공장:

"compilerOptions": [ "dom", "es2017" ]

작동하지 않습니다:

"compilerOptions": [ "es2017", "dom" ]

"수정"이 없으면 다음이 발생합니다.

$ tsc -b tsconfig.dev.json
node_modules/@types/jsdom/index.d.ts:28:40 - error TS2304: Cannot find name 'DocumentFragment'.

28         static fragment(html: string): DocumentFragment;
                                          ~~~~~~~~~~~~~~~~

node_modules/@types/jsdom/index.d.ts:45:28 - error TS2304: Cannot find name 'Node'.

45         nodeLocation(node: Node): ElementLocation | null;
                              ~~~~

node_modules/@types/jsdom/index.d.ts:188:19 - error TS2304: Cannot find name 'HTMLScriptElement'.

188         element?: HTMLScriptElement | HTMLLinkElement | HTMLIFrameElement | HTMLImageElement;
                      ~~~~~~~~~~~~~~~~~

node_modules/@types/jsdom/index.d.ts:188:39 - error TS2304: Cannot find name 'HTMLLinkElement'.

188         element?: HTMLScriptElement | HTMLLinkElement | HTMLIFrameElement | HTMLImageElement;
                                          ~~~~~~~~~~~~~~~
<snip - numerous other errors>

1. jest 테스트에는 testEnvironment: 'jsdom' 와 달리 'node' 합니다.

"수정"이 없으면 다음이 발생합니다.

$ jest --runInBand plugins/maven
 FAIL  plugins/maven/__tests__/maven.test.ts
  maven
    updatePomVersion
      ✕ should replace the previousVersion with the newVersion (39ms)

  ● maven › updatePomVersion › should replace the previousVersion with the newVersion

    ReferenceError: XPathEvaluator is not defined

      51 | ) => {
      52 |   const pomDom = new jsdom.JSDOM(content, {contentType: "text/xml"}).window.document;
    > 53 |   const evaluator = new XPathEvaluator();
         |                     ^
      54 |   const resolver = evaluator.createNSResolver(pomDom.documentElement);
      55 |   const expression = evaluator.createExpression("/project/version", resolver);
      56 |   const versionNode = expression.evaluate(pomDom.documentElement, XPathResult.FIRST_ORDERED_NODE_TYPE);

      at Object.exports.updatePomVersion (plugins/maven/src/index.ts:53:21)
      at Object.test (plugins/maven/__tests__/maven.test.ts:53:26)

플러그인의 루트 구성에 설정된 경우 위의 "수정" 중 어느 것도 작동하지 않습니다(예: plugins/maven/tsconfig.json 또는 plugins/maven/package.json 의 jest 구성 모두). 루트 구성 파일을 변경해도 테스트나 기능에 부정적인 영향을 미치지 않는 것으로 보입니다.

이것은 당신의 지점에 있습니까? 나는 아마 이것을 고칠 수 있다

아직 아닙니다... 저는 모든 테스트(및 새로운 테스트)를 푸시하기 전에 통과하는지 확인하고 있습니다. 검토할 준비가 되면 핑을 보내드리겠습니다.

방금 master를 내 브랜치로 리베이스했는데 이제 몇 가지 빌드 오류가 발생합니다.

먼저 yarn.lock 파일이 병합 충돌로 인해 중단되었으므로 삭제하고 다시 작성해야 했습니다.

error Incorrect integrity when fetching from the cache for "babel-plugin-jest-hoist". Cache has "sha512-u+/W+WAjMlvoocYGTwthAiQSxDcJAyHpQ6oWlHdFZaaN+Rlk8Q7iiwDPg2lN/FyJtAYnKjFxbn7xus4HCFkg5g== sha1-EpyAulx/x1uvOkW5Pi43LVfKJnc=" and remote has "sha512-+AuoehOrjt9irZL7DOt2+4ZaTM6dlu1s5TTS46JBa0/qem4dy7VNW3tMb96qeEqcIh20LD73TVNtmVEeymTG7w==". Run `yarn cache clean` to fix the problem

일단 그렇게하면 이제 @octokit/graphql 오류가 발생합니다.

$ tsc -b tsconfig.dev.json
packages/core/src/auto.ts:2018:13 - error TS2571: Object is of type 'unknown'.

2018         if (result?.[`hash_${commit}`]) {
                 ~~~~~~

packages/core/src/auto.ts:2019:27 - error TS2571: Object is of type 'unknown'.

2019           const number = (result[`hash_${commit}`] as ISearchResult).edges[0]
                               ~~~~~~

packages/core/src/release.ts:286:52 - error TS2769: No overload matches this call.
  Overload 1 of 2, '(o: ArrayLike<unknown> | { [s: string]: unknown; }): [string, unknown][]', gave the following error.
    Argument of type 'unknown' is not assignable to parameter of type 'ArrayLike<unknown> | { [s: string]: unknown; }'.
      Type 'unknown' is not assignable to type '{ [s: string]: unknown; }'.
  Overload 2 of 2, '(o: {}): [string, any][]', gave the following error.
    Argument of type 'unknown' is not assignable to parameter of type '{}'.

286       (acc, result) => [...acc, ...(Object.entries(result) as QueryEntry[])],
                                                       ~~~~~~


packages/core/src/__tests__/git.test.ts:209:12 - error TS2571: Object is of type 'unknown'.

209     expect(result!.data).not.toBeUndefined();
               ~~~~~~~


Found 4 errors.

error Command failed with exit code 2.

나는 이것을 위한 PR을 만들 수 있기를 매우 희망했지만 아직 준비가 되지 않았다는 것이 걱정됩니다.

난 그냥 체크 아웃 - 좋아, 내가 할 필요가 무엇인지했다 yarn.lock 에서 파일 master 다음-실행 다시 yarn clean && yarn install && yarn build && yarn test plugins/maven 하고 내가 잘하는 것 같아요 -가다.

엄청난! 오늘 리뷰하겠습니다. 주말에 답장을 드리지 못해 죄송합니다!

:rocket: v9.40.0 에서 발행된 문제 :rocket: