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.

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

Jump to bottom

Escape backticks, when publishing releases #63

Closed
playpauseandstop opened this issue May 9, 2021 · 1 comment · Fixed by #67 or #70
Closed

Escape backticks, when publishing releases #63

playpauseandstop opened this issue May 9, 2021 · 1 comment · Fixed by #67 or #70
Assignees
@playpauseandstop
Labels
bug Something isn’t working
Milestone
21.2.0

Comments

@playpauseandstop
Copy link
Owner

Currently, if release commit contains backticks, they are not escaped and as result inner content does not go to release notes.

Need to escape backticks, to ensure that all inner content will properly published in release notes.
@playpauseandstop playpauseandstop added the bug Something isn’t working label May 9, 2021
@playpauseandstop playpauseandstop self-assigned this May 9, 2021
@playpauseandstop playpauseandstop added this to the 21.2.0 milestone May 12, 2021
playpauseandstop added a commit that referenced this issue May 12, 2021
@playpauseandstop
fix: Escape backticks when setting output at GitHub Actions
14987b0 
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 mentioned this issue May 12, 2021
Merged
playpauseandstop added a commit that referenced this issue May 12, 2021
@playpauseandstop
fix: Escape backticks when setting output at GitHub Actions (#67)
caa8d8a 
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
badabump-release-bot bot pushed a commit that referenced this issue May 12, 2021
@playpauseandstop
chore: 21.2.0 Release
d975aef 
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)
@badabump-release-bot badabump-release-bot bot mentioned this issue May 12, 2021
Merged
playpauseandstop added a commit that referenced this issue May 12, 2021
@badabump-release-bot @playpauseandstop
chore: 21.2.0 Release (#68)
b8f478b 
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>
@playpauseandstop
Copy link
Owner Author

The fix doesn't have much sense due to fail in https://github.com/playpauseandstop/badabump/runs/2569562370?check_suite_focus=true

Need to figure out other possibilities to the fix.

playpauseandstop added a commit that referenced this issue May 12, 2021
@playpauseandstop
fix: Do not escape backticks & shell vars
f1b0b0d 
But use single quotes for tag message in `release_pr` workflow.

Fixes: #63
@playpauseandstop playpauseandstop mentioned this issue May 12, 2021
Merged
playpauseandstop added a commit that referenced this issue May 12, 2021
@playpauseandstop
fix: Do not escape backticks & shell vars (#70)
1dcdb2e 
But use single quotes for tag message in `release_pr` workflow.

Fixes: #63
badabump-release-bot bot pushed a commit that referenced this issue May 12, 2021
@playpauseandstop
chore: 21.2.0 Release
8b16206 
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)
@badabump-release-bot badabump-release-bot bot mentioned this issue May 12, 2021
Merged
playpauseandstop added a commit that referenced this issue May 12, 2021
@badabump-release-bot @playpauseandstop
chore: 21.2.0 Release (#71)
0b9e20a 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@playpauseandstop playpauseandstop

Labels
bug Something isn’t working
Projects
None yet
Milestone
21.2.0
1 participant
@playpauseandstop