infracost / docs

Infracost docs
https://Infracost.io
Other
12 stars 31 forks source link

Add instructions for Semaphore CI/CD platform to docs. #363

Closed TomFern closed 1 year ago

TomFern commented 1 year ago

This proposal is to add instructions to configure Infracost with Semaphore CI/CD to the integration section of the docs.

We've tested Infracost with the CI/CD platform and it works great. I've written a tutorial on how to configure it on the Semaphore blog.

If this proposal is approved I can volunteer to write the documentation (I work as a technical writer on Semaphore) or contribute with code/snippets, configuration files and screenshots.

Thank you Tomas

alikhajeh1 commented 1 year ago

Hi @TomFern - thanks! What do you think about hosting the docs on https://docs.semaphoreci.com/ so you can update/maintain it fully and we can link to it from https://www.infracost.io/docs/integrations/third_party_integrations/ ?

BTW that tutorial was 👌👌👌

TomFern commented 1 year ago

Hey @alikhajeh1 thank you! I like this idea. We already have multiple integrations described our docs, so it would be easy to add a page about Infracost.

We'll work on it and let you know when it's online, so you may add a link on the Infracost docs.

alikhajeh1 commented 1 year ago

@TomFern awesome - thanks! 🚀 I've assigned this issue to myself to remember to setup the links when you're done. We can also link to your docs in our monthly update newsletter.

TomFern commented 1 year ago

Hi @alikhajeh1 sorry for the delay. We've added an article about configuring Infracost in our docs. You may link to this doc page in your documentation: https://docs.semaphoreci.com/examples/estimating-cloud-costs-with-infracost/

Let me know if you have any questions. Thanks a lot

alikhajeh1 commented 1 year ago

Thanks @TomFern! I'll take a look at this next week

alikhajeh1 commented 1 year ago

@TomFern sorry for the delay - I added the link in https://github.com/infracost/docs/pull/451 that'll go live tmrw. A few comments on the article:

  1. When installing the CLI, you can use curl -fsSL https://raw.githubusercontent.com/infracost/infracost/master/scripts/install.sh | INFRACOST_VERSION=v0.10 sh to force the latest version of the v0.10 CLI to avoid breaking CI/CD pipelines when we introduce breaking changes in v0.11 but at the same time pickup the latest patch fixes and new resources.
  2. In this section, I'm not quite sure how baseline.json file is being generated.
TomFern commented 1 year ago

Hi @alikhajeh1 thank you for adding the link and doing the review. I'll take care of fixing the issues you mentioned 🙇‍♂️

alikhajeh1 commented 1 year ago

Thanks @TomFern!

TomFern commented 1 year ago

@alikhajeh1 thank you for the feedback. I fixed the docs on our side to reflect your comments.