Skip to content

feat: add extra-files input #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bcoe merged 4 commits into from
Jan 17, 2022
Merged

feat: add extra-files input #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b456228
feat: add extra-files input
Jan 3, 2022
01f705c
build
jcornaz Jan 13, 2022
d9b8deb
Update README.md
jcornaz Jan 14, 2022
37cffc4
remove unnecessary step id in readme
jcornaz Jan 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Automate releases with Conventional Commit Messages.
| `monorepo-tags` | add prefix to tags and branches, allowing multiple libraries to be released from the same repository. |
| `changelog-types` | A JSON formatted String containing to override the outputted changelog sections |
| `version-file` | provide a path to a version file to increment (used by ruby releaser) |
| `extra-files` | add extra-files to bump using the [generic updater](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files) |
Copy link
Copy Markdown

@bcoe bcoe Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
```?

Copy link
Copy Markdown
Contributor Author

@jcornaz jcornaz Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

@jcornaz jcornaz Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Copy link
Copy Markdown

@bcoe bcoe Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Creating major/minor tags

Along the lines of Adding additional files.

Copy link
Copy Markdown
Contributor Author

@jcornaz jcornaz Jan 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the readme

| `fork` | Should the PR be created from a fork. Default `false`|
| `command` | release-please command to run, either `github-release`, or `release-pr`, `manifest`, `manifest-pr` (_defaults to running both_) |
| `default-branch` | branch to open pull release PR against (detected by default) |
Expand Down Expand Up @@ -271,6 +272,30 @@ jobs:
git push origin v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}
```

## Adding additional files

You can update additional files with the `extra-files` input.

See the [generic updater docs](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files) for more info on how release-please will update those files.

```yaml
on:
push:
branches:
- main
name: release-please
jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: GoogleCloudPlatform/release-please-action@v3
with:
release-type: node
extra-files: |
README.md
docs/getting-started.md
```

## License

Apache Version 2.0
4 changes: 4 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ inputs:
description: 'provide a path to a version file to increment (used by ruby releaser)'
required: false
default: ''
extra-files:
description: 'extra files to bump using the generic updater'
required: false
default: ''
default-branch:
description: 'branch to open pull release PR against (detected by default)'
required: false
Expand Down
2 changes: 2 additions & 0 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ async function main () {
const changelogTypes = core.getInput('changelog-types') || undefined
const changelogSections = changelogTypes && JSON.parse(changelogTypes)
const versionFile = core.getInput('version-file') || undefined
const extraFiles = core.getMultilineInput('extra-files') || undefined
const github = await getGitHubInstance()
const pullRequestTitlePattern = core.getInput('pull-request-title-pattern') || undefined
const draft = core.getBooleanInput('draft')
Expand All @@ -92,6 +93,7 @@ async function main () {
changelogPath,
changelogSections,
versionFile,
extraFiles,
includeComponentInTag: monorepoTags,
pullRequestTitlePattern,
draftPullRequest
Expand Down
2 changes: 2 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ async function main () {
const changelogTypes = core.getInput('changelog-types') || undefined
const changelogSections = changelogTypes && JSON.parse(changelogTypes)
const versionFile = core.getInput('version-file') || undefined
const extraFiles = core.getMultilineInput('extra-files') || undefined
const github = await getGitHubInstance()
const pullRequestTitlePattern = core.getInput('pull-request-title-pattern') || undefined
const draft = core.getBooleanInput('draft')
Expand All @@ -85,6 +86,7 @@ async function main () {
changelogPath,
changelogSections,
versionFile,
extraFiles,
includeComponentInTag: monorepoTags,
pullRequestTitlePattern,
draftPullRequest
Expand Down
⚡