mirror of
https://github.com/FranzDiebold/github-env-vars-action.git
synced 2024-11-26 02:31:00 -05:00
Improve documentation.
This commit is contained in:
parent
71f6f104cc
commit
d4fc571a0d
4 changed files with 8 additions and 8 deletions
6
.github/workflows/demo.yml
vendored
6
.github/workflows/demo.yml
vendored
|
@ -7,7 +7,7 @@ jobs:
|
||||||
name: Linux Demo
|
name: Linux Demo
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: franzdiebold/github-env-vars-action@v1.1.2
|
- uses: FranzDiebold/github-env-vars-action@v1.1.3
|
||||||
- name: Print environment variables exposed by this action
|
- name: Print environment variables exposed by this action
|
||||||
run: |
|
run: |
|
||||||
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
||||||
|
@ -25,7 +25,7 @@ jobs:
|
||||||
name: Windows Demo
|
name: Windows Demo
|
||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: franzdiebold/github-env-vars-action@v1.1.2
|
- uses: FranzDiebold/github-env-vars-action@v1.1.3
|
||||||
- name: Print environment variables exposed by this action
|
- name: Print environment variables exposed by this action
|
||||||
run: |
|
run: |
|
||||||
echo "GITHUB_REPOSITORY_OWNER=$Env:GITHUB_REPOSITORY_OWNER"
|
echo "GITHUB_REPOSITORY_OWNER=$Env:GITHUB_REPOSITORY_OWNER"
|
||||||
|
@ -43,7 +43,7 @@ jobs:
|
||||||
name: macOS Demo
|
name: macOS Demo
|
||||||
runs-on: macos-latest
|
runs-on: macos-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: franzdiebold/github-env-vars-action@v1.1.2
|
- uses: FranzDiebold/github-env-vars-action@v1.1.3
|
||||||
- name: Print environment variables exposed by this action
|
- name: Print environment variables exposed by this action
|
||||||
run: |
|
run: |
|
||||||
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
[![GitHub Action: View on Marketplace](https://img.shields.io/badge/GitHub%20Action-View_on_Marketplace-28a745?logo=github)](https://github.com/marketplace/actions/github-environment-variables-action)
|
[![GitHub Action: View on Marketplace](https://img.shields.io/badge/GitHub%20Action-View_on_Marketplace-28a745?logo=github)](https://github.com/marketplace/actions/github-environment-variables-action)
|
||||||
[![Demo: available](https://img.shields.io/badge/Demo-available-orange)](.github/workflows/demo.yml)
|
[![Demo: available](https://img.shields.io/badge/Demo-available-orange)](.github/workflows/demo.yml)
|
||||||
[version](https://img.shields.io/github/package-json/v/FranzDiebold/github-env-vars-action/primary?label=version)
|
![Version: v1.1.3](https://img.shields.io/badge/Version-v1.1.3-brightgreen)
|
||||||
[![Lint and Test](https://github.com/FranzDiebold/github-env-vars-action/workflows/Lint%20and%20Test/badge.svg)](https://github.com/FranzDiebold/github-env-vars-action/actions?query=workflow%3A%22Lint+and+Test%22)
|
[![Lint and Test](https://github.com/FranzDiebold/github-env-vars-action/workflows/Lint%20and%20Test/badge.svg)](https://github.com/FranzDiebold/github-env-vars-action/actions?query=workflow%3A%22Lint+and+Test%22)
|
||||||
[![license: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](./LICENSE)
|
[![license: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](./LICENSE)
|
||||||
|
|
||||||
|
@ -29,11 +29,11 @@ For a full list of default environment variables exposed by GitHub see [https://
|
||||||
| `GITHUB_SHA` | The commit SHA that triggered the workflow. | `ffac537e6cbbf934b08745a378932722df287a53` |
|
| `GITHUB_SHA` | The commit SHA that triggered the workflow. | `ffac537e6cbbf934b08745a378932722df287a53` |
|
||||||
| `GITHUB_REF` | The branch or tag ref that triggered the workflow. If neither a branch or tag is available for the event type, the variable will not exist. | `refs/heads/feat/feature-branch-1` |
|
| `GITHUB_REF` | The branch or tag ref that triggered the workflow. If neither a branch or tag is available for the event type, the variable will not exist. | `refs/heads/feat/feature-branch-1` |
|
||||||
|
|
||||||
## Example usage
|
## :rocket: Example usage
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- uses: franzdiebold/github-env-vars-action@v1.1.2
|
- uses: FranzDiebold/github-env-vars-action@v1.1.3
|
||||||
- name: Print environment variables
|
- name: Print environment variables
|
||||||
run: |
|
run: |
|
||||||
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER"
|
||||||
|
|
2
package-lock.json
generated
2
package-lock.json
generated
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "github-env-vars-action",
|
"name": "github-env-vars-action",
|
||||||
"version": "1.1.2",
|
"version": "1.1.3",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "github-env-vars-action",
|
"name": "github-env-vars-action",
|
||||||
"version": "1.1.2",
|
"version": "1.1.3",
|
||||||
"description": "A GitHub Action to expose useful environment variables.",
|
"description": "A GitHub Action to expose useful environment variables.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|
Loading…
Reference in a new issue