diff --git a/README.md b/README.md index 4123d52..071e7ed 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ # GitHub Slug action -[![Release][release]][actions] -[![Linux Usage][linux-use]][actions] -[![MacOS Usage][macos-use]][actions] -[![Windows][windows-use]][actions] -![Lint][lint] -[![Public workflows that use this action.][8]][9] -[![Licence][11]][12] +[![Release][release-badge]][releases] +![Lint][lint-badge] +[![Public workflows that use this action][who-use-it]][use-count-badge] +[![Licence][license-badge]][license] -This GitHub Action will expose the slug/short values of [some GitHub environment variables][10] inside your GitHub workflow. +This GitHub Action will expose the slug/short values of [some GitHub environment variables][github-env-vars] inside your GitHub workflow. ## Table of Contents @@ -61,13 +58,13 @@ Add this in your workflow uses: rlespinasse/github-slug-action@v3.x ``` -Check for more [examples][3] (OS usage, URL use, ...) +Check for more [examples][examples] (OS usage, URL use, ...) -**Tip:** Use [Dependabot][14] to maintain your `github-slug-action` version updated in your GitHub workflows. +**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows. ## Available Environment variables -**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][5]. +**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][custom-variable]. ### Partial variables @@ -80,15 +77,15 @@ Check for more [examples][3] (OS usage, URL use, ...) **NOTE:** `_CS` suffix available -| Variable | Slug version of | Description | -| ------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------- | -| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug) | GITHUB_REPOSITORY | The owner and repository name. | -| [GITHUB_REPOSITORY
_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name. | -| [GITHUB_REPOSITORY
_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug) | GITHUB_REPOSITORY_NAME_PART | The repository name. | -| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug) | GITHUB_REF | The branch or tag ref that triggered the workflow. | -| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug) | GITHUB_HEAD_REF | The branch of the head repository.
Only set for [pull-request][4] event and forked repositories. | -| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug) | GITHUB_BASE_REF | The branch of the base repository.
Only set for [pull-request][4] event and forked repositories. | -| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug) | _github.event.ref_ |
Only set for [following webhook events][4] | +| Variable | Slug version of | Description | +| ------------------------------------------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug) | GITHUB_REPOSITORY | The owner and repository name. | +| [GITHUB_REPOSITORY
_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name. | +| [GITHUB_REPOSITORY
_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug) | GITHUB_REPOSITORY_NAME_PART | The repository name. | +| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug) | GITHUB_REF | The branch or tag ref that triggered the workflow. | +| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug) | GITHUB_HEAD_REF | The branch of the head repository.
Only set for [pull-request][event-pull-request] event and forked repositories. | +| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug) | GITHUB_BASE_REF | The branch of the base repository.
Only set for [pull-request][event-pull-request] event and forked repositories. | +| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug) | _github.event.ref_ |
Only set for [following webhook events][4] | ### Slug URL variables @@ -119,7 +116,7 @@ Follow [Developers guide](DEVELOPERS.md) ### One of environement variable don't work as intended -[**Note**][17]: GitHub reserves the `GITHUB_` environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the `GITHUB_` prefix will result in an error. +[**Note**][naming-conventions]: GitHub reserves the `GITHUB_` environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the `GITHUB_` prefix will result in an error. Currently, a GitHub workflow setting a `GITHUB_` variable don't ended up in error. And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one. @@ -159,35 +156,33 @@ Download action repository 'rlespinasse/github-slug-action@master' > The master branch don't exists anymore. > -> The master branch EOL have been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7]) +> The master branch EOL have been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][issue-15]) -Please, use the current branch `v3.x` or a version tag (see [releases pages][6]) in order to fix your workflow. +Please, use the current branch `v3.x` or a version tag (see [releases pages][releases]) in order to fix your workflow. ## Thanks for talking about us -- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][15] (in french :fr:) -- [Github Actions : enfin des pipelines accessibles aux développeurs][16] (in french :fr:) +- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:) +- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:) - The next one is you. _Don't hesitate to add you to this list._ -[actions]: https://github.com/rlespinasse/github-slug-action/actions -[release]: https://github.com/rlespinasse/github-slug-action/workflows/Release/badge.svg -[linux-use]: https://github.com/rlespinasse/github-slug-action/workflows/Use%20on%20Linux/badge.svg -[macos-use]: https://github.com/rlespinasse/github-slug-action/workflows/Use%20on%20MacOS/badge.svg -[windows-use]: https://github.com/rlespinasse/github-slug-action/workflows/Use%20on%20Windows/badge.svg -[lint]: https://github.com/rlespinasse/github-slug-action/workflows/Lint/badge.svg +[release-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Release?label=Build&logo=github&style=flat-square +[lint-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Lint?label=Lint&logo=github&style=flat-square +[use-count-badge]: https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue +[license-badge]: https://img.shields.io/github/license/rlespinasse/github-slug-action?style=flat-square -[3]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples -[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads -[5]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title= -[6]: https://github.com/rlespinasse/github-slug-action/releases -[7]: https://github.com/rlespinasse/github-slug-action/issues/15 -[8]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue -[9]: https://github.com/search?o=desc&q=rlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code -[10]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables -[11]: https://img.shields.io/github/license/rlespinasse/github-slug-action -[12]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE -[14]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot -[15]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8 -[16]: https://www.youtube.com/watch?v=RHnTJBwcE98 -[17]: -https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables +[actions]: https://github.com/rlespinasse/github-slug-action/actions +[license]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE +[examples]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples +[custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title= +[releases]: https://github.com/rlespinasse/github-slug-action/releases +[issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15 + +[who-use-it]: https://github.com/search?o=desc&q=rlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code +[github-env-vars]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables +[dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot +[event-pull-request]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads +[naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables + +[article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8 +[talk-1]: https://www.youtube.com/watch?v=RHnTJBwcE98