Allow templating

[kaerbr]

I added templating functioniality to url, type and filepath like already done in #365 for label.
Closes #406

Hope you like it (:

[MrSplint3r]

Why did you do these changes that can be seen here?
https://github.com/semantic-release/gitlab/compare/cc91eddc3bc7bbe7eee1253baeb2f51f1241d7d1..65deb545bccef9b779c84df87741c6af9e2f2ce8

This means you are using now template literals on your test, which is replacing the ${...} expressions before Lodash can even get to it. The $ needs to be kept escaped for them to be replaced only at Lodash time. Or simply don't use the backticks.

Your tests where you try to use process.env.XXX vars will most likely not work since the process object is not present in the context given to the Lodash template here:

gitlab/lib/publish.js

Line 48 in 65deb54

const _url = asset.url ? template(asset.url)(context) : undefined;

[kaerbr]

Why did you do these changes that can be seen here? https://github.com/semantic-release/gitlab/compare/cc91eddc3bc7bbe7eee1253baeb2f51f1241d7d1..65deb545bccef9b779c84df87741c6af9e2f2ce8

This means you are using now template literals on your test, which is replacing the ${...} expressions before Lodash can even get to it. The $ needs to be kept escaped for them to be replaced only at Lodash time. Or simply don't use the backticks.

The linting stage of the test was failing before this change. But you are right that lodash wont get to the ${...} expressions. I will add a change. (:

Your tests where you try to use process.env.XXX vars will most likely not work since the process object is not present in the context given to the Lodash template here:

gitlab/lib/publish.js

Line 48 in 65deb54

const _url = asset.url ? template(asset.url)(context) : undefined;

But why would the tests run if this was the case? -- sry I'm new to Javascript. :(
Ok so I did a testrun with semantic-release/gitlab@9.3.2 (since v9.2.0 label templating is implemented) and it seems to work :

• relevant parts of the .releaserc.yml:

- - "@semantic-release/gitlab"
    - assets:
        - url: "https://my.url"
          label: "${process.env.LABEL}"
          type: other

• relevant parts of the .gitlab-ci.yml:

semantic-release:
  stage: release
  script:
    - export LABEL="my-label"
    - npm install -g semantic-release@19 @semantic-release/changelog@6 @semantic-release/exec@6 @semantic-release/git@10 @semantic-release/gitlab@9
    - semantic-release --debug

• relevant parts of the debug output:

2022-06-22T06:02:52.221Z semantic-release:gitlab POST-ing the following JSON to https://gitlab.com/api/v4/projects/kaerbr%2Fsemantic-release-test/releases:
{
  "tag_name": "v1.8.0",
  "description": "# [1.8.0](https://gitlab.com/kaerbr/semantic-release-test/compare/v1.7.0...v1.8.0) (2022-06-22)\n\n\n### Features\n\n* process:env.XXX ([a361fd5](https://gitlab.com/kaerbr/semantic-release-test/commit/a361fd5bce4785ffeb9c8f6c266507700ceefa00))\n\n\n\n",
  "assets": {
    "links": [
      {
        "name": "my-label",
        "url": "https://my.url/",
        "link_type": "other"
      }
    ]
  }
}

So since I implemented the changes like for the label templating I think this should work and be fine? (: -- Or am I missing something?

[MrSplint3r]

Sorry, I was mistaken, the env vars object is indeed available on the context passed to the template functions, just under the name env. See here:
https://github.com/semantic-release/semantic-release/blob/9589a96239826abe9b07e8deffcc7d8aeb9c2e40/index.js#L257
https://github.com/semantic-release/semantic-release/blob/9589a96239826abe9b07e8deffcc7d8aeb9c2e40/index.js#L250

In that sense, now I understood why your tests are succeeding, even though you were using ${process.env.XXX} instead of ${env.XXX}. That's because Lodash also interprets that as a JavaScript expression and since process.env is available globally, it was able to resolve it.

I could definitely use this functionality as well so from me a 👍 for the contribution. :)

[fgreinacher]

Thanks for your work @kaerbr, I left some comments, ping me if you need support!

[fgreinacher]

@kaerbr Thanks for adapting the tests! Ping me once you addressed the other comments - also if I should take over something!

[kaerbr]

@kaerbr Thanks for adapting the tests! Ping me once you addressed the other comments - also if I should take over something!

@fgreinacher I think I replied to all comments or pushed changes. -- waiting for your review/answers. (:

[fgreinacher]

Thanks @kaerbr, looking great!

[github-actions]

🎉 This PR is included in version 9.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀