Skip to content
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.

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

fix: Escape backticks when setting output at GitHub Actions #67

Merged
merged 1 commit into from
May 12, 2021

Conversation

playpauseandstop
Copy link
Owner

Apply same logic as for escaping %, \n, \r, but now for escaping backticks itself.

It also might be useful to escape $, to avoid bash variable substitution, so add them to escape list as well.

Fixes: #63

Apply same logic as for escaping `%`, `\n`, `\r`, but now for escaping
backticks itself.

It also might be useful to escape `$`, to avoid bash variable
substitution, so add them to escape list as well.

Fixes: #63
@playpauseandstop playpauseandstop added the fix A bug fix label May 12, 2021
@playpauseandstop playpauseandstop self-assigned this May 12, 2021
@playpauseandstop playpauseandstop merged commit caa8d8a into master May 12, 2021
@playpauseandstop playpauseandstop deleted the fix/63 branch May 12, 2021 19:04
badabump-release-bot bot pushed a commit that referenced this pull request May 12, 2021
Features:
---------

- [#34] Put refactor commits into separate section (#58)

Fixes:
------

- [#64] Support pre-releases with multiple digits (#66)
- [#63] Escape backticks when setting output at GitHub Actions (#67)

Other:
------

- (**deps-dev**) Bump coverage from 5.3.1 to 5.4 (#47)
- (**deps-dev**) Bump pytest from 6.2.1 to 6.2.2 (#50)
- (**deps-dev**) Bump pytest-cov from 2.10.1 to 2.11.1 (#49)
- (**deps-dev**) Bump time-machine from 1.3.0 to 2.0.1 (#48)
- (**deps**) Bump peter-evans/create-pull-request from v3.6.0 to v3.8.0 (#51)
- Bump Python dev version to 3.9.2 (#57)
- (**deps**) Bump actions/cache from v2.1.3 to v2.1.4 (#55)
- (**deps**) Bump pypa/gh-action-pypi-publish from v1.4.1 to v1.4.2 (#54)
- (**deps**) Bump peter-evans/create-pull-request from v3.8.0 to v3.8.2 (#56)
- Update to Python 3.9.4 (#59)
- (**deps**) Bump actions/setup-python from v2.2.1 to v2.2.2 (#60)
- (**deps**) Bump actions/cache from v2.1.4 to v2.1.5 (#61)
- (**deps**) Bump pre-commit/action from v2.0.0 to v2.0.3 (#62)
- Update Python dev version to 3.9.5 (#65)
playpauseandstop added a commit that referenced this pull request May 12, 2021
Now `badabump` escapes backticks in release notes, which allows to put
code blocks in GitHub Releases description, using standard Markdown syntax,

```python
def new_release() -> str:
    return "It is working!"
```

Features:
---------

- [#34] Put refactor commits into separate section (#58)

Fixes:
------

- [#64] Support pre-releases with multiple digits (#66)
- [#63] Escape backticks when setting output at GitHub Actions (#67)

Other:
------

- (**deps-dev**) Bump coverage from 5.3.1 to 5.4 (#47)
- (**deps-dev**) Bump pytest from 6.2.1 to 6.2.2 (#50)
- (**deps-dev**) Bump pytest-cov from 2.10.1 to 2.11.1 (#49)
- (**deps-dev**) Bump time-machine from 1.3.0 to 2.0.1 (#48)
- (**deps**) Bump peter-evans/create-pull-request from v3.6.0 to v3.8.0 (#51)
- Bump Python dev version to 3.9.2 (#57)
- (**deps**) Bump actions/cache from v2.1.3 to v2.1.4 (#55)
- (**deps**) Bump pypa/gh-action-pypi-publish from v1.4.1 to v1.4.2 (#54)
- (**deps**) Bump peter-evans/create-pull-request from v3.8.0 to v3.8.2 (#56)
- Update to Python 3.9.4 (#59)
- (**deps**) Bump actions/setup-python from v2.2.1 to v2.2.2 (#60)
- (**deps**) Bump actions/cache from v2.1.4 to v2.1.5 (#61)
- (**deps**) Bump pre-commit/action from v2.0.0 to v2.0.3 (#62)
- Update Python dev version to 3.9.5 (#65)

Co-authored-by: playpauseandstop <playpauseandstop@users.noreply.github.com>
badabump-release-bot bot pushed a commit that referenced this pull request May 12, 2021
Features:
---------

- [#34] Put refactor commits into separate section (#58)

Fixes:
------

- [#64] Support pre-releases with multiple digits (#66)
- [#63] Escape backticks when setting output at GitHub Actions (#67)
- [#63] Do not escape backticks & shell vars (#70)

Other:
------

- (**deps-dev**) Bump coverage from 5.3.1 to 5.4 (#47)
- (**deps-dev**) Bump pytest from 6.2.1 to 6.2.2 (#50)
- (**deps-dev**) Bump pytest-cov from 2.10.1 to 2.11.1 (#49)
- (**deps-dev**) Bump time-machine from 1.3.0 to 2.0.1 (#48)
- (**deps**) Bump peter-evans/create-pull-request from v3.6.0 to v3.8.0 (#51)
- Bump Python dev version to 3.9.2 (#57)
- (**deps**) Bump actions/cache from v2.1.3 to v2.1.4 (#55)
- (**deps**) Bump pypa/gh-action-pypi-publish from v1.4.1 to v1.4.2 (#54)
- (**deps**) Bump peter-evans/create-pull-request from v3.8.0 to v3.8.2 (#56)
- Update to Python 3.9.4 (#59)
- (**deps**) Bump actions/setup-python from v2.2.1 to v2.2.2 (#60)
- (**deps**) Bump actions/cache from v2.1.4 to v2.1.5 (#61)
- (**deps**) Bump pre-commit/action from v2.0.0 to v2.0.3 (#62)
- Update Python dev version to 3.9.5 (#65)
- 21.2.0 Release (#68)
- 21.2.0 Release (#68) (#69)
playpauseandstop added a commit that referenced this pull request May 12, 2021
Now `badabump` supports backticks in release notes, which allows to put code
blocks in GitHub Releases description, using standard Markdown syntax,

```python
def new_release() -> str:
    return "It is working!"
```

Features:
---------

- [#34] Put refactor commits into separate section (#58)

Fixes:
------

- [#64] Support pre-releases with multiple digits (#66)
- [#63] Escape backticks when setting output at GitHub Actions (#67)
- [#63] Do not escape backticks & shell vars (#70)

Other:
------

- (**deps-dev**) Bump coverage from 5.3.1 to 5.4 (#47)
- (**deps-dev**) Bump pytest from 6.2.1 to 6.2.2 (#50)
- (**deps-dev**) Bump pytest-cov from 2.10.1 to 2.11.1 (#49)
- (**deps-dev**) Bump time-machine from 1.3.0 to 2.0.1 (#48)
- (**deps**) Bump peter-evans/create-pull-request from v3.6.0 to v3.8.0 (#51)
- Bump Python dev version to 3.9.2 (#57)
- (**deps**) Bump actions/cache from v2.1.3 to v2.1.4 (#55)
- (**deps**) Bump pypa/gh-action-pypi-publish from v1.4.1 to v1.4.2 (#54)
- (**deps**) Bump peter-evans/create-pull-request from v3.8.0 to v3.8.2 (#56)
- Update to Python 3.9.4 (#59)
- (**deps**) Bump actions/setup-python from v2.2.1 to v2.2.2 (#60)
- (**deps**) Bump actions/cache from v2.1.4 to v2.1.5 (#61)
- (**deps**) Bump pre-commit/action from v2.0.0 to v2.0.3 (#62)
- Update Python dev version to 3.9.5 (#65)

Co-authored-by: playpauseandstop <playpauseandstop@users.noreply.github.com>
@coveralls
Copy link

Coverage Status

Coverage increased (+0.005%) to 97.15% when pulling 14987b0 on fix/63 into 5d5288c on master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix A bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Escape backticks, when publishing releases
2 participants