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

Workaround strings bug when generating function docs #9421

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

joshcooper
Copy link
Contributor

@joshcooper joshcooper commented Jul 22, 2024

Added a newline between the require statement and start of documentation to work around puppetlabs/puppet-strings#296

To verify, run:

echo 'gem "puppet-strings"' >> Gemfile.local
bundle update
bundle exec puppet strings generate --format json --out /tmp/strings.json
jq -r '.puppet_functions[] | select(.name == "yaml_data").docstring.text ' /tmp/strings.json | head

This should be backported to 7.x

Added a newline between the require statement and start of documentation
to work around puppetlabs/puppet-strings#296

To verify, run:

    echo 'gem "puppet-strings"' >> Gemfile.local
    bundle update
    bundle exec puppet strings generate --format json --out /tmp/strings.json
    jq -r '.puppet_functions[] | select(.name == "yaml_data").docstring.text ' /tmp/strings.json | head
@joshcooper joshcooper added the maintenance Maintenance chores are excluded from changelogs label Jul 22, 2024
@joshcooper joshcooper marked this pull request as ready for review July 22, 2024 23:02
@joshcooper joshcooper requested a review from a team as a code owner July 22, 2024 23:02
@mhashizume mhashizume merged commit 141ad4b into puppetlabs:main Jul 26, 2024
10 checks passed
@mhashizume mhashizume added the backport 7.x Generate a backport PR to 7.x label Jul 26, 2024
Copy link

Successfully created backport PR for 7.x:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 7.x Generate a backport PR to 7.x maintenance Maintenance chores are excluded from changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants