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

Blog: IgnoreErrors and Az group command #1854

Merged
merged 5 commits into from
Jan 27, 2022

Conversation

carolynvs
Copy link
Member

@carolynvs carolynvs commented Jan 7, 2022

What does this change

This adds a blog post about some new features in v1:

  • Explain the new ignoreError feature in the exec mixin
  • Show how developers can use this functionality to create custom commands for this mixin.

What issue does it fix

BLOG ALL THE THINGS!

Notes for the reviewer

I am going to tell people to make custom commands for mixins but we don't really have enough guidance for that yet. I've opened getporter/skeletor#29 to help address that.

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

* Explain the new ignoreError feature in the exec mixin
* Show how developers can use this functionality to create custom
commands for this mixin.

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs
Copy link
Member Author

Hey @squillace this was really bothering me the other day so I treated myself after coming back from vacation to adding error handling to the exec mixin. Take a look:

https://deploy-preview-1854--porter.netlify.app/blog/ignoring-errors/

@carolynvs carolynvs marked this pull request as ready for review January 10, 2022 17:56
Copy link
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

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

Reads great! LGTM.

docs/content/blog/ignoring-errors.md Outdated Show resolved Hide resolved
docs/content/blog/ignoring-errors.md Outdated Show resolved Hide resolved
## Try it out

Bundle authors, try out moving some of that custom error handling logic out of bash scripts and move it into your exec mixin calls.
Mixin authors, take a look at how the az mixin uses the exec mixin library to add error handling.
Copy link
Member

Choose a reason for hiding this comment

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

Should we link to the PR adding the logic in the az mixin? Or maybe source code?

Copy link
Member Author

Choose a reason for hiding this comment

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

The more I thought about it the more I think that just looking at an existing mixin is pretty hard to figure out what's going on. I will hold off on the blog post and implement this stuff in skeletor with lots of comments so that we can point people to that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Once getporter/skeletor#31 is merged I'll link to the source code that demonstrates how to do this in skeletor

carolynvs and others added 2 commits January 10, 2022 15:12
Signed-off-by: Carolyn Van Slyck <[email protected]>

Co-authored-by: Vaughn Dice <[email protected]>
Signed-off-by: Carolyn Van Slyck <[email protected]>
---

When is an error not really an error?
Questions like this come up regularly when automating deployments.
Copy link
Contributor

Choose a reason for hiding this comment

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

is this the question? (The when is an error not really an error) and more something like .. Why is my automated deployment erroring out when the resources exist? or something else. It's almost like when is an error not really an error is presupposing folks understanding what's up with the feature that based on me not being as steeped in what's going on with Porter really confused me at first by the title/description even.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll rework it so that it's less clever and more clear. 👍

Take another try at introducing the problem fixed by ignoreError

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs
Copy link
Member Author

@iennae I've rewritten the introductory paragraph, what do you think?

@carolynvs
Copy link
Member Author

I'm going to ship this blog post since at this point the release is getting a bit old and I've already cut a new one yesterday. Hopefully my edits were sufficient 🤞

@carolynvs
Copy link
Member Author

Oops just realized I'm still waiting for the PR to skeletor to be approved. 😇

@carolynvs carolynvs merged commit 7087318 into getporter:main Jan 27, 2022
@carolynvs carolynvs deleted the blog-ignore-errors branch January 27, 2022 23:11
carolynvs added a commit to carolynvs/porter that referenced this pull request Feb 7, 2022
* Merge pull request getporter#1884 from carolynvs/blog-secret
* Merge pull request getporter#1891 from carolynvs/survey
* Blog: IgnoreErrors and Az group command (getporter#1854)
* Merge pull request getporter#1871 from carolynvs/heading-spa
* Merge pull request getporter#1861 from carolynvs/pr-checklis
* Merge pull request getporter#1850 from carolynvs/link-v1-doc
* Merge pull request getporter#1847 from mikebarkas/1845--anch
* 1757  completion command (getporter#1844)
* Merge pull request getporter#1839 from carolynvs/status-badg
* docs: 1841 Fix typo and align template divs (getporter#1842)

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs carolynvs mentioned this pull request Feb 7, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants