Skip to content

Conversation

MidasLamb
Copy link
Contributor

This is useful if you don't actually want to release, but you're just interested in whether or not a release would be created. Useful to gate a secondary job with an environment, without creating requests for each and every change.

Fixes #200

This is useful if you don't actually want to release, but you're just interested in whether or not a release would be created. Useful to gate a secondary job with an environment, without creating requests for each and every change.

Fixes release-plz#200
If the input `command` is left unspecified (and so both `release` and `release-pr` are ran),
the `--dry-run` flag is only added to the `release` command
(the flag isn't added to the `release-pr` command).
Useful if you're only interested in whether or not a release (pr) would be created."
Copy link
Member

Choose a reason for hiding this comment

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

how do you determine if a release-pr will be created? can you explain more?

@marcoieni
Copy link
Member

marcoieni commented Apr 18, 2025

@robo9k
Copy link
Contributor

robo9k commented Aug 1, 2025

release-pr does not have a --dry-run option, so maybe instead of 2 inputs that leave us with 4 combinations - one being invalid - we could extend command options "release", "release-pr" with "release-dryrun".

      - uses: release-plz/[email protected]
        with:
          command: release-dryrun

I know this doesn't cleanly map to CLI commands anymore, but renaming the input is a worse breaking change.

Another alternative is to just have an "untyped" options input that is not specific to dry run and the user would then specify it explicitly:

      - uses: release-plz/[email protected]
        with:
          command: release
          options: --dry-run

FYI I'm interested in this (or rather #200) since a conditional environment can not be implemented by the action itself, as far as I understand, so for this advanced case release-plz/release-plz#2312 (comment) would not be enough.

@marcoieni
Copy link
Member

marcoieni commented Aug 6, 2025

I prefer having the 2 inputs with the 4 combinations instead of "release-dryrun". Seems cleaner.
We can return an error if command: release-pr and dry_run: true

@marcoieni marcoieni merged commit af52851 into release-plz:main Oct 11, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow for dry-runs

3 participants