-
Notifications
You must be signed in to change notification settings - Fork 20
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
Replace deprecated ioutil
usage with the equivalent replacements
#198
Replace deprecated ioutil
usage with the equivalent replacements
#198
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy with the ioutil
related changes but I'd appreciate if you could moved out the markdown changes, perhaps into a separate PR.
We can discuss any comments concerning markdown there.
README.md
Outdated
|
||
## Example Usage | ||
|
||
See examples at https://pkg.go.dev/github.com/hashicorp/hc-install#example-Installer. | ||
See examples at <https://pkg.go.dev/github.com/hashicorp/hc-install#example-Installer>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I struggle to find the meaning of this <URL>
syntax - do you mind sharing link to any relevant docs to help me understand the reason for the change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use markdownlint to format Markdown
- The rule for the "no bare URL's" is MD034 - https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md
docs/CONTRIBUTING.md
Outdated
2. Wait for [`build` workflow](https://github.com/hashicorp/hc-install/actions/workflows/build.yml) to finish | ||
3. Run the Release workflow with the appropriate version (matching the one in `version/VERSION`) & SHA (long one). | ||
4. Wait for a message in the Slack channel saying that authorisation is needed to promote artifacts to production. Click on the link and approve. | ||
5. Once notified that promotion is successful, go to <https://github.com/hashicorp/crt-workflows-common/actions/workflows/promote-production-packaging.yml>, locate the hc-install promote-production-packaging workflow, and approve. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't mind the whitespace removal but I would strongly prefer the indexes to stay as-is, i.e. 1
. The reason is that if a human goes to add another item into the middle of the list, they have to re-index any following numbers.
Also similar question here about the <URL>
syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure thing, I understand that logic
Hey @radeksimko, yeah I'll remove the Markdown changes from this PR and open them up in another 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the move.
What
Since Go 1.16 and Go 1.17,
ioutil
usage has been deprecated (most of the funcs call theos
orio
equivalents behind-the-scenes.This PR just replaces the ioutil usage with the equivalent replacements.
The PR also lints the Markdown files.