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: remove unnecessary curly brackets in doc-deploy-changelog docs #476

Merged
merged 1 commit into from
May 6, 2024

Conversation

klmcadams
Copy link
Contributor

As the title says

@klmcadams klmcadams requested a review from a team as a code owner May 1, 2024 13:16
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added the bug Defects or glitches reported by users or developers label May 1, 2024
@SMoraisAnsys
Copy link
Contributor

@klmcadams The pattern ${{ '{{ SOMETING }}' }} seems to be used all over the other actions. I'm not aware of any conflict when moving from ${{ '{{ SOMETHING }}' }} to ${{ SOMETHING }} so it might make sense to apply your changes to other actions right ?
@RobPasMue @jorgepiloto Are you aware of any limitations ?

@klmcadams
Copy link
Contributor Author

@SMoraisAnsys I think we have to keep ${{ '{{ SOMETHING }}' }} in the doc/source/*/examples/ yaml files because if they don't have that format there will be an error when making the docs:

In doc/source/doc-actions/examples/doc-changelog-basic.yml, if you remove '{{ }}', you get this error:
jinja2.exceptions.UndefinedError: 'secrets' is undefined

The rst files in the migrations folder still works without the extra '{{ }}' though

@RobPasMue
Copy link
Member

Just what @klmcadams pointed out - it is important that in the "examples" YAML files we follow the double curly braces approach. Jinja resolves the first set of curly braces and we need them as part of the syntax. But in this case, the migration guide is fine to just use them once.

@RobPasMue RobPasMue merged commit 92eb6c6 into main May 6, 2024
16 checks passed
@RobPasMue RobPasMue deleted the fix/doc-var-refs branch May 6, 2024 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects or glitches reported by users or developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants