feat: add extra-files input

[jcornaz]

resolve #343

Add the extra-files input option.

See: https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files

[bcoe]

@jcornaz try installing the latest version of release-please and running npm run build.

[jcornaz]

Thanks @bcoe. It does work now :-)

[bcoe]

@jcornaz mind rebasing?

[jcornaz]

@bcoe I rebased 👍

[bcoe]

A small additional example in README.md, that demonstrates how to provide multiline input I think would be valuable, I assume it's:

extra-files:
  - file a
  - file b
```?

[jcornaz]

Yes, I'll add an example.

Here is how to provide multiline inputs:

extra-files: |
  file1
  file2

IMO the syntax you mentioned would have bean nicer, because that's how we are used to define lists in yaml, but github actions uses multi-line input instead: actions/toolkit#829

[jcornaz]

@bcoe I am not sure where I should add the example in the readme. Should it be directly in the table of inputs? Or should I add a dedicated section later in the readme?

[bcoe]

@jcornaz I'd just add an extra section after:

Creating major/minor tags

Along the lines of Adding additional files.

[jcornaz]

I updated the readme

[bcoe]

@jcornaz thank you 🥳

[patoncrispy]

How does this work with updating xml or json files? How can I set the xpath?

[jcornaz]

How does this work with updating xml or json files? How can I set the xpath?

You cannot set a XPath. In the file you want to update, you have to comment in the file where are the part want to update. See: https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files for more details

Example:

<myxml>
  <version>1.0.0</version> <!-- x-release-please-version -->
</myxml>

[patoncrispy]

Thanks @jcornaz . I've tried that with the simple strategy but it's ignoring the extra-files option. At least, I cannot see anything in the output and there's no change in the PR it creates. Are there any examples of how to use this? The docs are pretty light.

[jcornaz]

Mmh strange, it should work. I suggest you open an issue and share an example of how to reproduce.