Skip to content

Commit

Permalink
add admonition
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman committed Dec 21, 2023
1 parent 5c9118f commit 992f650
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,28 +56,28 @@ screenshots:
# Short description of this project
description: |-
This `build-harness` is a collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more.
It's designed to work with CI/CD systems such as GitHub Actions, Codefresh, Travis CI, CircleCI and Jenkins.
It's designed to work with CI/CD systems such as GitHub Actions.
## Regarding the phase out of `git.io`
Prior to April 25, 2022, practically all Cloud Posse Makefiles pulled in a common Makefile via
```bash
curl -sSL -o .build-harness "https://git.io/build-harness"
```
The `git.io` service is a link shortener/redirector provided by GitHub, but [they no longer support it](https://github.blog/changelog/2022-04-25-git-io-deprecation/).
We have therefore set up `https://cloudposse.tools/build-harness` as an alternative and are migrating
all our Makefiles to use that URL instead. We encourage you to update any references you have in your
own code derived from our code, whether by forking one of our repos or simply following one of our examples.
Full details are available in our [`git.io` deprecation documentation](docs/git-io-deprecation.md).
# Introduction to the project
#introduction: |-
# This is an introduction.

# How to use this project
usage: |-
> [!IMPORTANT] Regarding the phase out of `git.io`
> Prior to April 25, 2022, practically all Cloud Posse Makefiles pulled in a common Makefile via
> ```bash
> curl -sSL -o .build-harness "https://git.io/build-harness"
> ```
>
> The `git.io` service is a link shortener/redirector provided by GitHub, but [they no longer support it](https://github.blog/changelog/2022-04-25-git-io-deprecation/).
> We have therefore set up `https://cloudposse.tools/build-harness` as an alternative and are migrating
> all our Makefiles to use that URL instead. We encourage you to update any references you have in your
> own code derived from our code, whether by forking one of our repos or simply following one of our examples.
>
> Full details are available in our [`git.io` deprecation documentation](docs/git-io-deprecation.md).
At the top of your `Makefile` add, the following...
```make
Expand Down

0 comments on commit 992f650

Please sign in to comment.