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

Update release.yaml to avoid command substitution on Markdown #1197

Merged
merged 2 commits into from
Feb 21, 2024

Conversation

shouth
Copy link
Contributor

@shouth shouth commented Feb 21, 2024

Description

  • Update .github/workflows/Release.yaml to avoid shell command substituion on Markdown content

Abstract

Existing workflow directly expands Markdown content to shell command. If expanded Markdown contains code spans like this, workflow applys command substitution on them. This PR update workflow to store Markdown content before generating release_description.txt to avoid command substitution.

Background

When PR description is written like this:
image

PR description is expanded into command in GitHub Actions,
image

and command substitution is conducted.
image

Details

Assign ${{ github.event.pull_request.body }} to the environment variable $PULL_REQUEST_BODY and output it to release_description.txt.

References

https://github.com/tier4/scenario_simulator_v2/actions/runs/7985003102/job/21802726254

Destructive Changes

N/A

Known Limitations

N/A

Copy link

github-actions bot commented Feb 21, 2024

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

  • Is this pull request written in a way that is easy to read from a third-party perspective?
  • Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
  • If this pull request contains a destructive change, does this pull request contain the migration guide?
  • Labels of this pull request are valid?
  • All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
  • The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

@shouth shouth added the bump patch If this pull request merged, bump patch version of the scenario_simulator_v2 label Feb 21, 2024
@shouth shouth marked this pull request as draft February 21, 2024 07:36
@hakuturu583 hakuturu583 assigned hakuturu583 and shouth and unassigned hakuturu583 Feb 21, 2024
@hakuturu583 hakuturu583 marked this pull request as ready for review February 21, 2024 07:52
@hakuturu583 hakuturu583 merged commit 67eb108 into master Feb 21, 2024
11 checks passed
@hakuturu583 hakuturu583 deleted the fix/release_description branch February 21, 2024 08:07
@github-actions github-actions bot restored the fix/release_description branch February 21, 2024 08:07
@github-actions github-actions bot deleted the fix/release_description branch February 21, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump patch If this pull request merged, bump patch version of the scenario_simulator_v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants