feat(action): show CI url in pullrequest body

[olblak]

Fix #1717

Test

Well I don't see how to test this feature without taking the risk of conflicting with the GitHub Action environment used to test Updatecli so I am just doing manual testing at this stage.

We must use an Updatecli that need to change something

export GITHUB_ACTION="true" 
export GITHUB_SERVER_URL="https://github.com" 
export GITHUB_REPOSITORY="foo/bar" 
export GITHUB_RUN_ID="1658821493" 

./bin/updatecli diff --config updatecli/updatecli.d/venom.yaml --debug

Please note <a href="https://github.com/foo/bar/actions/runs/1658821493">GitHub Action pipeline link</a> in the console output

Console Output

DEBUG: The expected action would have the following information:
	|	
	|	##Title:
	|	ci: bump Venom version to v1.0.1
	|	
	|	
	|	##Report:
	|	
	|	<Action id="1c70af8de95bd7989d99731b82355dfdd0fbd5981ebfef645550823023b51711">
	|	    <h3>ci: bump Venom version</h3>
	|	    <details id="dc3a5f47e02ede555033ee1e6cb765e5e88ea60e3352a90edb40cb190d142911">
	|	        <summary>ci: update Venom version to v1.0.1</summary>
	|	        <p>1 file(s) updated with &#34;VENOM_VERSION: v1.0.1&#34;:&#xA;&#x9;* .github/workflows/go.yaml&#xA;</p>
	|	        <details>
	|	            <summary>v1.0.1</summary>
	|	            <pre>&#xA;Release published on the 2021-12-13 16:52:12 +0000 UTC at the url https://github.com/ovh/venom/releases/tag/v1.0.1&#xA;&#xA;# Venom v1.0.1&#xD;&#xA;&#xD;&#xA;## What&#39;s Changed&#xD;&#xA;* fix: handle json number is assertions (#460) https://github.com/ovh/venom/pull/464&#xD;&#xA;&#xD;&#xA;**Full Changelog**: https://github.com/ovh/venom/compare/v1.0.0...v1.0.1</pre>
	|	        </details>
	|	    </details>
	|	    <a href="https://github.com/foo/bar/actions/runs/1658821493">GitHub Action pipeline link</a>
	|	</Action>
	|	
	|	=====
	|	

=============================

This pullrequest introduces in a new action setting pipelineurl such as

actions:
    default:
        title: 'ci: bump Venom version to {{ source "latestVersion" }}'
        kind: github/pullrequest
        disablepipelineurl: true
        spec:
            automerge: true
            labels:
                - chore
                - skip-changelog
        scmid: default

Additional Information

Tradeoff

Potential improvement

• I need to gate this feature behind a setting at the action level

[dduportal]

LGTM. I've added a few nitpicks, you're free to select them or not.

The last one (duplication of variables) is NOT a blocker. IF you want me to send a PR,n that will be a good exercise for me to put my hand dirty in updatecli again (haven't done it since a long time)

[dduportal]

I wonder if the pipelineurl shouldn't be true by default (e.g. opt-out) as it would not break any existing use case.

Eventually, it could be under the experimental flag (e.g. enabled by default if --experimental) for early testing, and then in 1-2 version enabled by default.

WDYT @olblak ?

[olblak]

I wonder if the pipelineurl shouldn't be true by default (e.g. opt-out) as it would not break any existing use case.

For me pipelineurl set to false means the current behavior which is not showing the pipeline url.
While set to true means we want to see the URL.

In long term I think having this opt-out by default would be better so I don't think the experimental flag is needed here as we don't the current behavior

[dduportal]

I wonder if the pipelineurl shouldn't be true by default (e.g. opt-out) as it would not break any existing use case.

For me pipelineurl set to false means the current behavior which is not showing the pipeline url. While set to true means we want to see the URL.

In long term I think having this opt-out by default would be better so I don't think the experimental flag is needed here as we don't the current behavior

I'm personally in favor of setting it to true by default, e.g. "if you use the new updatecli version, then you will have your PR with the link added by default"

[dduportal]

Approving, whatever default is chosen

[olblak]

I'm personally in favor of setting it to true by default, e.g. "if you use the new updatecli version, then you will have your PR with the link added by default"

I was taking a more defensive approach, even thought I would also prefer to display the url by default

I am going to change the setting pipelineurl to disablepipelineurl to enable it by default

[v1v]

💯 Thanks so much!!!