Skip to content

Disable line wrapping in base64 encoding #28743

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
Merged
merged 4 commits into from
Oct 2, 2023
Merged

Disable line wrapping in base64 encoding #28743

merged 4 commits into from
Oct 2, 2023

Conversation

fstagni
Copy link
Contributor

@fstagni fstagni commented Oct 2, 2023 •
edited
Loading

Why:

This PR corrects 2 separate issues within the same line:

  1. at least on linux, the command base64 does not have a -o switch: https://www.man7.org/linux/man-pages/man1/base64.1.html, and redirecting with > is the way to go
  2. the option -w 0 removes line wrapping (which by default is every 76 chars). Line wrapping can cause issues while running base64 --decode

I also removed the -i option as, to be honest, I fail to see why that would be useful in this case.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Disable line wrapping in base64 encoding (for storing binary blobs as secrets).

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.

  • For content changes, I have completed the self-review checklist.

@welcome
Copy link

welcome bot commented Oct 2, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/security-guides/using-secrets-in-github-actions.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
 fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@fstagni Thanks for submitting a PR!

Before I triage this, would you mind adding a bit more information as to why this change is beneficial to the docs? We'd appreciate any more details ✨

@cmwilson21 cmwilson21 added the more-information-needed More information is needed to complete review label Oct 2, 2023
@fstagni
Copy link
Contributor Author

fstagni commented Oct 2, 2023

@fstagni Thanks for submitting a PR!

Before I triage this, would you mind adding a bit more information as to why this change is beneficial to the docs? We'd appreciate any more details ✨

I updated the "why" section in the PR description.

@cmwilson21
Copy link
Contributor

@fstagni This is helpful! Thank you for making that update! I'll get this up for review ✨

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team more-information-needed More information is needed to complete review labels Oct 2, 2023
skedwards88
skedwards88 reviewed Oct 2, 2023
View reviewed changes
Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this fix! I left one suggestion since I think macos doesn't support the -w option (https://www.unix.com/man-page/osx/1/base64/). I'll go ahead and incorporate that, then we'll get this merged for you.

@skedwards88 skedwards88 enabled auto-merge October 2, 2023 22:57
@skedwards88 skedwards88 added hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! ready to merge This pull request is ready to merge labels Oct 2, 2023
@skedwards88 skedwards88 added this pull request to the merge queue Oct 2, 2023
Merged via the queue into github:main with commit f6fdfb0 Oct 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@skedwards88 skedwards88 skedwards88 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fstagni @cmwilson21 @skedwards88