Auto: maven-release-pluginの要件を削除します

同意します！

私がpom.xmlから得た情報に関するあなたのポイントのほとんどは、おそらくそれらのフィールドについての私の誤解に関係しています。 ここでの変更は大歓迎です。

私は私たちがしなければならないどんな重大な変更にもすべて賛成です。 おそらく、＃1156で詳述されている小さな破壊的な変更のいくつかをロールバックすることができます

<scm/>と<developers/>に関する私の2つのポイントが間違っているようです。 npmプラグインは、それらをpackage.jsonからプルします。 これは、それらがpom.xml配置されるべきであることを意味しますか？

それらがnpm repository authorフィールドとpomである場合、はい。

作者はを介して設定されます pom.xmlのセクション。これは、コミットを実行する人が、選択した作成者と同じでない場合があることを意味します。 gitcommitの作成者を情報。

これはnpmプラグインにも当てはまります。 ローカル自動はgit構成をオーバーライドしませんが、CI環境ではauthorをcommit`に設定する必要がある場合があります。

所有者とリポジトリの情報は、 セクション。これは、現在のクローンの実際のリポジトリおよび所有者とは異なる場合があります。

これは違うのでしょうか？ npmの世界では、 repositoryフィールドは通常、パッケージのコードを指します。 実際には、通常、 forkでautoを実行することはありません。実行する場合は、 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を使用する2つの方法を見つけました。これらは、本日遅くにテストする予定です。

@hipstersmoothie getAuthor 、 getRepoなどのフックの動作について質問があります-RE： //github.com/intuit/auto/issues/1260#issuecommentに関するコメント- 634280655、私はテストを見ています、そして彼らはそれと矛盾しているようです。

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

したがって、 undefined AuthorInformationを返しても、エラーはスローされません。

私が間違っている可能性があること、またはフック処理にthrowを再導入する必要があるかどうかについての提案はありますか？

他のすべてのプラグインがどのように機能するかを考えると、これは間違いなく間違っています。 未定義を返すのが正しい方法です。 そうすれば、必要に応じて、 coreをローカルで構成されたgitユーザーにフォールバックできます。

お奨め-それは私が考えたものなので、失敗したフックが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 ：

リモート履歴を汚染することなく実際のプロジェクトでコードをテストできるように、変更を中央リポジトリにプッシュするコードをコメントアウトしました。

これで私に与えることができるどんな助けも大いに感謝されます-私は「コードを実行する」という昔ながらの方法に頼るのではなく、pom.xmlファイルをどれだけうまく変更できるかをチェックするためにテストを使用できることを望んでいます実際のファイル、実際のファイルを確認し、 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をルートファイルまたはMaven package.jsonファイルに追加します。

xml2jsは、XML => JSON => XML変換中にすべてのXMLコメントをサイレントに削除するため、ジョブを実行しないことに気づきました。 私はそれを機能させるように努めてきました、そしてそれは歯を抜くようなものです。 xml2js変換を移動するときに、XMLが元のように見えるという保証はありません。これは大きな問題です。

1つのプラグインだけのテストを実行するには、ルートから実行します。

yarn test plugins/maven

次に、実際に変更を加えることなく、行うすべての変更または作成するアーティファクトを簡単に表示できるかどうかという疑問が生じます。

それはかなり大きな問題のように思えます。 そのファイルの編集を可能にするJava環境で出荷された標準CLIはありますか？

構成ファイル用のパーサーを持たないプラグイン（例：ruby）の場合、 autoは主に正規表現を使用してファイルを更新します。

beforeRun問題を見る機会がありましたか？ 回避策はありますが、本当にハッキーな感じがします...

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リポジトリへのコミットが表示されませんか？

今私は実際にプッシュしました

これにより、現在同期タップを使用しているプラ​​グインに重大な変更が発生しますか？

いいえ。 同期タップは同じように機能するはずです。 これは、約束をタップする機能を追加するだけです

私は、脆弱でエラーが発生しやすい正規表現を使用して、この作業を成功させました。 私の懸念は、 <version/>要素がpom.xmlファイルのどこでも使用されていることです-アーティファクトバージョンと依存関係とプラグインのために。 言い換えると、正規表現は、想定外のバージョンを誤って変更する可能性が非常に高くなります。

（xmldom、xmldom-ts、xml2js、xml2jsonなどを介して）XML DOMを操作しようとすると、壮大な比率の泥沼に陥っています。 私は決して自分自身をtypescriptやjavascriptの専門家だとは思っていないので、おそらくそれが私が陥っているところです。

2つのことが私のお尻を蹴っています：

1. IntelliJにデバッグモードでMavenテスト（およびMavenテストのみ）を実行させる方法がわかりません。 うまくいくこともあれば、うまくいかないこともあります。
2. pom.xmlをDocumentロードし、xpathを使用して「/ project / version」ノードと「/ project / parent / version」ノードを選択します。

これらの2つの問題の間で、私はおそらく合計12〜16時間費やしましたが、本当にイライラしています。 私は今朝まで＃1を働いていたので、＃2は比較的単純なはずだと思いますが、それはあらゆる場面で私と戦っているようです。

maven-release-pluginがpom.xmlファイルの更新を処理するという途方もなく単純な理由で、maven-release-pluginの使用に戻る傾向があります。

IntelliJにデバッグモードでMavenテスト（およびMavenテストのみ）を実行させる方法がわかりません。 うまくいくこともあれば、うまくいかないこともあります。

申し訳ありませんが、ここではあまり役に立ちません。 私はVSCodeを使用しており、テストをデバッグすることはめったにありません。 yarn test plugins/mavenしてルートから実行できますか？

pom.xmlをドキュメントにロードし、xpathを使用して「/ project / version」ノードと「/ project / parent / version」ノードを選択します。

これは良い方法のようです。 それがうまくいくなら、それは良さそうです。

maven-release-pluginがpom.xmlファイルの更新を処理するという途方もなく単純な理由で、maven-release-pluginの使用に戻る傾向があります。

https://stackoverflow.com/questions/5726291/updating-version-numbers-of-modules-in-a-multi-module-maven-projectのようなプラグインベースのものだけがmavenで利用できますか？ 低レベルのmvnベースのものが最適です。

ところで、これに多くの時間を費やしてくれてありがとう！

フィードバックとサポートに感謝します。 暴言（っぽい）前のコメントでごめんなさい。

バージョンについての素晴らしい点-maven-plugin-私は以前にそれを使ったことがなく、それが存在することを知りませんでした。 それは確かに私にとって物事を簡単にするでしょう...それはmaven-release-pluginと自動プラグインを介してpom.xmlファイルを管理しようとすることの間の完全な妥協点です。

yarn test plugins/mavenを動作させることができます。 私はまた、従来のconsole.logではなく、デバッガーを使用して物事を検査するのが大好きなので、おそらくそれが私が必要以上に胸焼けを引き起こしているところです...

長く困難な旅の後、私はほとんど私はどちらか修正する完全なソリューション、考える何を持っているpom.xmlファイルを直接または使用versions-maven-pluginセットバージョンに。

いくつかの注意点があります。 pom.xmlを変更するために使用されるコードは、DOMで機能しており、次のような結果になります。

1. tsconfig.json処理にバグがあり、 "dom" libが"compilerOptions" "es2017"前にある必要があります。

作品：

"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構成も機能しません。 ルート構成ファイルに変更を加えても、テストや機能に悪影響を与えるようには見えませんでした。

これはあなたのブランチにありますか？ 私はおそらくこれを修正することができます

まだ...プッシュする前に、すべてのテスト（および新しいテスト）に合格していることを確認しています。 レビューの準備ができたら、pingを送信します。

マスターをブランチにリベースしたところ、いくつかのビルドエラーが発生しました。

最初に、マージの競合のために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：