mirror of
https://github.com/rlespinasse/github-slug-action.git
synced 2026-05-18 02:45:04 +00:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
172fe43594 | ||
|
|
12a7510630 | ||
|
|
b71a8a1cbc | ||
|
|
54910e921d | ||
|
|
35d90c4a71 | ||
|
|
ada34a0888 | ||
|
|
6370faccb7 | ||
|
|
81beb28f90 | ||
|
|
08cd74e0fa | ||
|
|
8c0a3268b6 | ||
|
|
016823880d | ||
|
|
e6c550f88c |
@@ -1,43 +1,21 @@
|
||||
name: Build
|
||||
name: Build OS-Dependent
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- v3.x
|
||||
pull_request:
|
||||
branches:
|
||||
- v3.x
|
||||
|
||||
jobs:
|
||||
build:
|
||||
use-on-linux:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- run: |
|
||||
npm ci
|
||||
- run: |
|
||||
npm run all
|
||||
- uses: cycjimmy/semantic-release-action@v2
|
||||
with:
|
||||
semantic_version: 17.3.4
|
||||
branches: |
|
||||
[
|
||||
'v2.x',
|
||||
'v3.x'
|
||||
]
|
||||
extra_plugins: |
|
||||
@semantic-release/changelog@5.0.1
|
||||
@semantic-release/git@9.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
|
||||
|
||||
os-test:
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os:
|
||||
- ubuntu-latest
|
||||
- macos-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- run: npm install
|
||||
- run: npm run all
|
||||
- uses: ./
|
||||
- name: Output
|
||||
run: |
|
||||
@@ -63,6 +41,10 @@ jobs:
|
||||
echo "Short SHA variables"
|
||||
echo " sha : ${{ env.GITHUB_SHA_SHORT }}"
|
||||
echo " pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
|
||||
echo "Branch Name"
|
||||
echo " raw : ${{ env.GITHUB_BRANCH_NAME }}"
|
||||
echo " slug : ${{ env.GITHUB_BRANCH_NAME_SLUG }}"
|
||||
echo " slug url : ${{ env.GITHUB_BRANCH_NAME_SLUG_URL }}"
|
||||
- name: Case Sensitive Output
|
||||
run: |
|
||||
echo "Slug variables"
|
||||
@@ -81,11 +63,75 @@ jobs:
|
||||
echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
|
||||
echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
|
||||
echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
|
||||
echo "Branch Name"
|
||||
echo " slug : ${{ env.GITHUB_BRANCH_NAME_SLUG_CS }}"
|
||||
echo " slug url : ${{ env.GITHUB_BRANCH_NAME_SLUG_URL_CS }}"
|
||||
|
||||
win-test:
|
||||
use-on-macos:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- run: npm install
|
||||
- run: npm run all
|
||||
- uses: ./
|
||||
- name: Output
|
||||
run: |
|
||||
echo "Partial variables"
|
||||
echo " repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
|
||||
echo " repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
|
||||
echo "Slug variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG }}"
|
||||
echo " repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
|
||||
echo " repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}"
|
||||
echo " ref : ${{ env.GITHUB_REF_SLUG }}"
|
||||
echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG }}"
|
||||
echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG }}"
|
||||
echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG }}"
|
||||
echo "Slug URL variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
|
||||
echo " repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
|
||||
echo " repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
|
||||
echo " ref : ${{ env.GITHUB_REF_SLUG_URL }}"
|
||||
echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}"
|
||||
echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL }}"
|
||||
echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}"
|
||||
echo "Short SHA variables"
|
||||
echo " sha : ${{ env.GITHUB_SHA_SHORT }}"
|
||||
echo " pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
|
||||
echo "Branch Name"
|
||||
echo " raw : ${{ env.GITHUB_BRANCH_NAME }}"
|
||||
echo " slug : ${{ env.GITHUB_BRANCH_NAME_SLUG }}"
|
||||
echo " slug url : ${{ env.GITHUB_BRANCH_NAME_SLUG_URL }}"
|
||||
- name: Case Sensitive Output
|
||||
run: |
|
||||
echo "Slug variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
|
||||
echo " repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
|
||||
echo " repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
|
||||
echo " ref : ${{ env.GITHUB_REF_SLUG_CS }}"
|
||||
echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
|
||||
echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
|
||||
echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
|
||||
echo "Slug URL variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
|
||||
echo " repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
|
||||
echo " repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
|
||||
echo " ref : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
|
||||
echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
|
||||
echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
|
||||
echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
|
||||
echo "Branch Name"
|
||||
echo " slug : ${{ env.GITHUB_BRANCH_NAME_SLUG_CS }}"
|
||||
echo " slug url : ${{ env.GITHUB_BRANCH_NAME_SLUG_URL_CS }}"
|
||||
|
||||
use-on-windows:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- run: npm install
|
||||
- run: npm run all
|
||||
- uses: ./
|
||||
- name: Output
|
||||
run: |
|
||||
@@ -111,6 +157,10 @@ jobs:
|
||||
echo "Short SHA variables"
|
||||
echo " sha : $env:GITHUB_SHA_SHORT"
|
||||
echo " pull request sha : $env:GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT"
|
||||
echo "Branch Name"
|
||||
echo " raw : $env:GITHUB_BRANCH_NAME"
|
||||
echo " slug : $env:GITHUB_BRANCH_NAME_SLUG"
|
||||
echo " slug url : $env:GITHUB_BRANCH_NAME_SLUG_URL"
|
||||
- name: Case Sensitive Output
|
||||
run: |
|
||||
echo "Slug variables"
|
||||
@@ -129,3 +179,6 @@ jobs:
|
||||
echo " head ref : $env:GITHUB_HEAD_REF_SLUG_URL_CS"
|
||||
echo " base ref : $env:GITHUB_BASE_REF_SLUG_URL_CS"
|
||||
echo " event ref : $env:GITHUB_EVENT_REF_SLUG_URL_CS"
|
||||
echo "Branch Name"
|
||||
echo " slug : $env:GITHUB_BRANCH_NAME_SLUG_CS"
|
||||
echo " slug url : $env:GITHUB_BRANCH_NAME_SLUG_URL_CS"
|
||||
38
.github/workflows/codeql-analysis.yml
vendored
38
.github/workflows/codeql-analysis.yml
vendored
@@ -1,34 +1,28 @@
|
||||
name: "CodeQL"
|
||||
name: CodeQL
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ v3.x, v*.x ]
|
||||
branches:
|
||||
- v3.x
|
||||
pull_request:
|
||||
branches: [ v3.x ]
|
||||
branches:
|
||||
- v3.x
|
||||
schedule:
|
||||
- cron: '0 6 * * 1'
|
||||
- cron: "0 6 * * 1"
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
analyse:
|
||||
name: analyze
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [ 'javascript' ]
|
||||
|
||||
language: ["javascript"]
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v1
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v1
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v1
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- uses: github/codeql-action/init@v1
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
- uses: github/codeql-action/autobuild@v1
|
||||
- uses: github/codeql-action/analyze@v1
|
||||
|
||||
10
.github/workflows/linter.yml
vendored
10
.github/workflows/linter.yml
vendored
@@ -5,6 +5,8 @@ on:
|
||||
branches:
|
||||
- v3.x
|
||||
pull_request:
|
||||
branches:
|
||||
- v3.x
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
@@ -12,13 +14,11 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v2
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Lint Code Base
|
||||
uses: github/super-linter@v3
|
||||
- uses: github/super-linter@v3
|
||||
env:
|
||||
VALIDATE_ALL_CODEBASE: false
|
||||
VALIDATE_JAVASCRIPT_STANDARD: false
|
||||
|
||||
25
.github/workflows/release-dryrun.yml
vendored
Normal file
25
.github/workflows/release-dryrun.yml
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
name: Release DryRun
|
||||
|
||||
on:
|
||||
push:
|
||||
branches-ignore:
|
||||
- v*.x
|
||||
|
||||
jobs:
|
||||
release-dryrun:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- run: npm install
|
||||
- run: npm run all
|
||||
- uses: ./
|
||||
- uses: cycjimmy/semantic-release-action@v2
|
||||
with:
|
||||
branches: |
|
||||
[
|
||||
"${{ env.GITHUB_REF_NAME }}"
|
||||
]
|
||||
dry_run: true
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
18
.github/workflows/release.yml
vendored
Normal file
18
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- v*.x
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: technote-space/auto-cancel-redundant-workflow@v1
|
||||
- uses: actions/checkout@v2
|
||||
- run: npm install
|
||||
- run: npm run all
|
||||
- uses: cycjimmy/semantic-release-action@v2
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
14
CHANGELOG.md
14
CHANGELOG.md
@@ -1,3 +1,17 @@
|
||||
# [3.6.0](http://github.com/rlespinasse/github-slug-action/compare/3.5.1...3.6.0) (2021-09-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add GITHUB_REF_NAME env var ([12a7510](http://github.com/rlespinasse/github-slug-action/commit/12a75106304d45442301df66d3ba38e1ac002649))
|
||||
|
||||
## [3.5.1](http://github.com/rlespinasse/github-slug-action/compare/3.5.0...3.5.1) (2021-03-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update dist files ([e6c550f](http://github.com/rlespinasse/github-slug-action/commit/e6c550f88ccca52a82675b89186b6b72864f087c))
|
||||
|
||||
# [3.5.0](http://github.com/rlespinasse/github-slug-action/compare/3.4.0...3.5.0) (2021-03-30)
|
||||
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ Include the relevant issue number if applicable.
|
||||
|
||||
## Do you intend to add a new feature or change an existing one
|
||||
|
||||
* Suggest your change by [opening a 'Feature request' issue][5] and start writing code.
|
||||
* Suggest your change by [opening a 'Feature request' issue][5] and start writing code (following the [developers guide](DEVELOPERS.md))
|
||||
|
||||
## Do you have questions about the source code
|
||||
|
||||
|
||||
@@ -1,11 +1,15 @@
|
||||
# Developers guide
|
||||
|
||||
## Prepare
|
||||
|
||||
Install the dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
## Develop
|
||||
|
||||
Build the typescript and package it for distribution
|
||||
|
||||
```bash
|
||||
@@ -24,3 +28,11 @@ $ npm test
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
Before creating a commit, validate your changes and build the associated distribution files
|
||||
|
||||
```bash
|
||||
npm run all
|
||||
```
|
||||
|
||||
136
README.md
136
README.md
@@ -1,11 +1,10 @@
|
||||
# GitHub Slug action
|
||||
|
||||
[![Actions Status][1]][2]
|
||||
![GitHub Super-Linter][13]
|
||||
[![Public workflows that use this action.][8]][9]
|
||||
[![Licence][11]][12]
|
||||
[![Release][release-badge]][releases]
|
||||
![Lint][lint-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
|
||||
|
||||
@@ -14,13 +13,14 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
|
||||
- [Overview](#overview)
|
||||
- [Use this action](#use-this-action)
|
||||
- [Available Environment variables](#available-environment-variables)
|
||||
- [Enhanced variables](#enhanced-variables)
|
||||
- [Partial variables](#partial-variables)
|
||||
- [Slug variables](#slug-variables)
|
||||
- [Slug URL variables](#slug-url-variables)
|
||||
- [Short variables](#short-variables)
|
||||
- [Contribute](#contribute)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [One of environement variable don't work as intended](#one-of-environement-variable-dont-work-as-intended)
|
||||
- [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
|
||||
- [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
|
||||
- [Thanks for talking about us](#thanks-for-talking-about-us)
|
||||
|
||||
@@ -37,14 +37,20 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
|
||||
<summary>Others <b>Slug-ish</b> commands are available</summary>
|
||||
<p>
|
||||
|
||||
- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL (Like `SLUG` but `.` is also replaced by `-`)
|
||||
- `SHORT` on a variable will limit the string size to 8 characters (useful for _sha_ value)
|
||||
- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
|
||||
- Like `SLUG` but `.` is also replaced by `-`
|
||||
- `SHORT` on a variable will limit the string size to 8 characters
|
||||
- Useful for _sha_ value
|
||||
- `<KEY>_PART` on a variable will give a part of a variable defined by a key
|
||||
_ `<VAR>_CS` on others variables to keep the value case-sensitive
|
||||
- Like `GITHUB_REPOSITORY_OWNER_PART` for the owner part of `GITHUB_REPOSITORY`
|
||||
- `<VAR>_CS` on others variables to keep the value case-sensitive
|
||||
- Like `GITHUB_REF_SLUG_CS`
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
Additional enhanced environment variables can be compute to help you around GitHub environment variables.
|
||||
|
||||
## Use this action
|
||||
|
||||
Add this in your workflow
|
||||
@@ -54,13 +60,21 @@ 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].
|
||||
|
||||
### Enhanced variables
|
||||
|
||||
- `GITHUB_REF_NAME` will contains the reference name (branch or tag)
|
||||
- based on `GITHUB_HEAD_REF` in a [`pull-request*`][webhooks-and-events] event context,
|
||||
- based on `GITHUB_REF` in others event context.
|
||||
|
||||
**NOTE:** All enhanced variables are available in all **slug** formats.
|
||||
|
||||
### Partial variables
|
||||
|
||||
@@ -73,36 +87,36 @@ 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<br>_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name. |
|
||||
| [GITHUB_REPOSITORY<br>_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.<br>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.<br>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_ | <br>Only set for [following webhook events][4]<ul><li>`create`</li><li>`delete`</li></ul> |
|
||||
| Variable | Slug version of | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug) | GITHUB_REPOSITORY | The owner and repository name. |
|
||||
| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name. |
|
||||
| [GITHUB_REPOSITORY<br>_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.<br>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.<br>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_ | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul> |
|
||||
|
||||
### Slug URL variables
|
||||
|
||||
**NOTE:** `_CS` suffix available
|
||||
|
||||
| Variable | Slug URL version of | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url) | GITHUB_REPOSITORY | The owner and repository name. |
|
||||
| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | GITHUB_REPOSITORY_OWNER_PART | The owner name. |
|
||||
| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url) | GITHUB_REPOSITORY_NAME_PART | The repository name. |
|
||||
| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url) | GITHUB_REF | The branch or tag ref that triggered the workflow. |
|
||||
| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url) | GITHUB_HEAD_REF | The branch of the head repository.<br>Only set for [pull-request][4] event and forked repositories. |
|
||||
| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url) | GITHUB_BASE_REF | The branch of the base repository.<br>Only set for [pull-request][4] event and forked repositories. |
|
||||
| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url) | _github.event.ref_ | <br>Only set for [following webhook events][4]<ul><li>`create`</li><li>`delete`</li></ul> |
|
||||
| Variable | Slug URL version of | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url) | GITHUB_REPOSITORY | The owner and repository name. |
|
||||
| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | GITHUB_REPOSITORY_OWNER_PART | The owner name. |
|
||||
| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url) | GITHUB_REPOSITORY_NAME_PART | The repository name. |
|
||||
| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url) | GITHUB_REF | The branch or tag ref that triggered the workflow. |
|
||||
| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url) | GITHUB_HEAD_REF | The branch of the head repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
|
||||
| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url) | GITHUB_BASE_REF | The branch of the base repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
|
||||
| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url) | _github.event.ref_ | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul> |
|
||||
|
||||
### Short variables
|
||||
|
||||
| Variable | Short version of | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short) | GITHUB_SHA | The commit SHA that triggered the workflow. |
|
||||
| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][4]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
|
||||
| Variable | Short version of | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short) | GITHUB_SHA | The commit SHA that triggered the workflow. |
|
||||
| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][webhooks-and-events]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
|
||||
|
||||
## Contribute
|
||||
|
||||
@@ -110,11 +124,11 @@ Follow [Developers guide](DEVELOPERS.md)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### One of environement variable don't work as intended
|
||||
### One of the environment variables doesn'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.
|
||||
Currently, a GitHub workflow setting a `GITHUB_` variable will not cause an error, it will just fail silently.
|
||||
And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one.
|
||||
|
||||
<details>
|
||||
@@ -150,33 +164,33 @@ Download action repository 'rlespinasse/github-slug-action@master'
|
||||
##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
|
||||
```
|
||||
|
||||
> The master branch don't exists anymore.
|
||||
> The master branch doesn'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 has 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:)
|
||||
- The next one is you. _Don't hesitate to add you to this list._
|
||||
- [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 youself to this list._
|
||||
|
||||
[1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg
|
||||
[2]: https://github.com/rlespinasse/github-slug-action/actions
|
||||
[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
|
||||
[13]: https://github.com/rlespinasse/github-slug-action/workflows/Lint/badge.svg
|
||||
[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
|
||||
[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
|
||||
[license-badge]: https://img.shields.io/github/license/rlespinasse/github-slug-action?style=flat-square
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
[webhooks-and-events]: 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
|
||||
|
||||
69
dist/index.js
vendored
69
dist/index.js
vendored
@@ -110,6 +110,10 @@ const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH';
|
||||
*/
|
||||
const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART';
|
||||
const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART';
|
||||
/**
|
||||
* New environments variables keys
|
||||
*/
|
||||
const GITHUB_REF_NAME = 'GITHUB_REF_NAME';
|
||||
/**
|
||||
* Slugged outputs environments variables keys
|
||||
*/
|
||||
@@ -127,6 +131,8 @@ const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG';
|
||||
const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS';
|
||||
const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG';
|
||||
const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS';
|
||||
const GITHUB_REF_NAME_SLUG = 'GITHUB_REF_NAME_SLUG';
|
||||
const GITHUB_REF_NAME_SLUG_CS = 'GITHUB_REF_NAME_SLUG_CS';
|
||||
/**
|
||||
* URL-Slugged outputs environments variables keys
|
||||
*/
|
||||
@@ -144,6 +150,8 @@ const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL';
|
||||
const GITHUB_BASE_REF_SLUG_URL_CS = 'GITHUB_BASE_REF_SLUG_URL_CS';
|
||||
const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL';
|
||||
const GITHUB_EVENT_REF_SLUG_URL_CS = 'GITHUB_EVENT_REF_SLUG_URL_CS';
|
||||
const GITHUB_REF_NAME_SLUG_URL = 'GITHUB_REF_NAME_SLUG_URL';
|
||||
const GITHUB_REF_NAME_SLUG_URL_CS = 'GITHUB_REF_NAME_SLUG_URL_CS';
|
||||
/**
|
||||
* Shorted outputs environments variables keys
|
||||
*/
|
||||
@@ -192,6 +200,7 @@ function run() {
|
||||
exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL);
|
||||
exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS);
|
||||
exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT);
|
||||
exportBranchName();
|
||||
}
|
||||
catch (error) {
|
||||
core.setFailed(error.message);
|
||||
@@ -253,15 +262,21 @@ function exportSecondPartSlug(inputKey, separator, outputKey) {
|
||||
function exportSlugRefCS(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slug_1.slugref_cs(envVar));
|
||||
exportSlugRefCSValue(envVar, outputKey);
|
||||
}
|
||||
}
|
||||
function exportSlugRefCSValue(envVar, outputKey) {
|
||||
core.exportVariable(outputKey, slug_1.slugref_cs(envVar));
|
||||
}
|
||||
function exportSlugRef(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slug_1.slugref(envVar));
|
||||
exportSlugRefValue(envVar, outputKey);
|
||||
}
|
||||
}
|
||||
function exportSlugRefValue(envVar, outputKey) {
|
||||
core.exportVariable(outputKey, slug_1.slugref(envVar));
|
||||
}
|
||||
function exportSlugUrlCS(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
@@ -305,21 +320,45 @@ function exportSecondPartSlugUrl(inputKey, separator, outputKey) {
|
||||
function exportSlugUrlRefCS(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slug_1.slugurlref_cs(envVar));
|
||||
exportSlugUrlRefCSValue(envVar, outputKey);
|
||||
}
|
||||
}
|
||||
function exportSlugUrlRefCSValue(envVar, outputKey) {
|
||||
core.exportVariable(outputKey, slug_1.slugurlref_cs(envVar));
|
||||
}
|
||||
function exportSlugUrlRef(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slug_1.slugurlref(envVar));
|
||||
exportSlugUrlRefValue(envVar, outputKey);
|
||||
}
|
||||
}
|
||||
function exportSlugUrlRefValue(envVar, outputKey) {
|
||||
core.exportVariable(outputKey, slug_1.slugurlref(envVar));
|
||||
}
|
||||
function exportShortSha(inputKey, outputKey) {
|
||||
const envVar = process.env[inputKey];
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, short_1.shortsha(envVar));
|
||||
}
|
||||
}
|
||||
function exportBranchName() {
|
||||
//GITHUB_HEAD_REF is only set for pull request events https://docs.github.com/en/actions/reference/environment-variables
|
||||
const isPullRequest = !!process.env.GITHUB_HEAD_REF;
|
||||
let refName;
|
||||
if (isPullRequest) {
|
||||
refName = process.env.GITHUB_HEAD_REF;
|
||||
}
|
||||
else {
|
||||
refName = process.env.GITHUB_REF;
|
||||
}
|
||||
if (refName) {
|
||||
core.exportVariable(GITHUB_REF_NAME, slug_1.removeRef(refName));
|
||||
exportSlugRefValue(refName, GITHUB_REF_NAME_SLUG);
|
||||
exportSlugRefCSValue(refName, GITHUB_REF_NAME_SLUG_CS);
|
||||
exportSlugUrlRefValue(refName, GITHUB_REF_NAME_SLUG_URL);
|
||||
exportSlugUrlRefCSValue(refName, GITHUB_REF_NAME_SLUG_URL_CS);
|
||||
}
|
||||
}
|
||||
run();
|
||||
|
||||
|
||||
@@ -435,6 +474,7 @@ exports.getInput = getInput;
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
function setOutput(name, value) {
|
||||
process.stdout.write(os.EOL);
|
||||
command_1.issueCommand('set-output', { name }, value);
|
||||
}
|
||||
exports.setOutput = setOutput;
|
||||
@@ -738,11 +778,11 @@ exports.get_second_part = get_second_part;
|
||||
"use strict";
|
||||
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.slugurlref = exports.slugurlref_cs = exports.slugurl = exports.slugurl_cs = exports.slugref = exports.slugref_cs = exports.slug = exports.slug_cs = void 0;
|
||||
exports.removeRef = exports.slugurlref = exports.slugurlref_cs = exports.slugurl = exports.slugurl_cs = exports.slugref = exports.slugref_cs = exports.slug = exports.slug_cs = void 0;
|
||||
const MAX_SLUG_STRING_SIZE = 63;
|
||||
/**
|
||||
* slug_cs will take envVar and then :
|
||||
* - replace any character by `-` except `0-9`, `a-z`, and `.`
|
||||
* - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
|
||||
* - remove leading and trailing `-` character
|
||||
* - limit the string size to 63 characters
|
||||
* @param envVar to be slugged
|
||||
@@ -754,7 +794,7 @@ exports.slug_cs = slug_cs;
|
||||
/**
|
||||
* slug will take envVar and then :
|
||||
* - put the variable content in lower case
|
||||
* - replace any character by `-` except `0-9`, `a-z`, and `.`
|
||||
* - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
|
||||
* - remove leading and trailing `-` character
|
||||
* - limit the string size to 63 characters
|
||||
* @param envVar to be slugged
|
||||
@@ -766,7 +806,7 @@ exports.slug = slug;
|
||||
/**
|
||||
* slugref_cs will take envVar and then :
|
||||
* - remove refs/(heads|tags|pull)/
|
||||
* - replace any character by `-` except `0-9`, `a-z`, and `.`
|
||||
* - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
|
||||
* - remove leading and trailing `-` character
|
||||
* - limit the string size to 63 characters
|
||||
* @param envVar to be slugged
|
||||
@@ -779,7 +819,7 @@ exports.slugref_cs = slugref_cs;
|
||||
* slugref will take envVar and then :
|
||||
* - remove refs/(heads|tags|pull)/
|
||||
* - put the variable content in lower case
|
||||
* - replace any character by `-` except `0-9`, `a-z`, and `.`
|
||||
* - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
|
||||
* - remove leading and trailing `-` character
|
||||
* - limit the string size to 63 characters
|
||||
* @param envVar to be slugged
|
||||
@@ -796,7 +836,7 @@ exports.slugref = slugref;
|
||||
* @param envVar to be slugged
|
||||
*/
|
||||
function slugurl_cs(envVar) {
|
||||
return slug_cs(replaceAnyDotToHyphen(envVar));
|
||||
return slug_cs(replaceAnyNonUrlCharactersWithHyphen(envVar));
|
||||
}
|
||||
exports.slugurl_cs = slugurl_cs;
|
||||
/**
|
||||
@@ -808,7 +848,7 @@ exports.slugurl_cs = slugurl_cs;
|
||||
* @param envVar to be slugged
|
||||
*/
|
||||
function slugurl(envVar) {
|
||||
return slug(replaceAnyDotToHyphen(envVar));
|
||||
return slug(replaceAnyNonUrlCharactersWithHyphen(envVar));
|
||||
}
|
||||
exports.slugurl = slugurl;
|
||||
/**
|
||||
@@ -840,14 +880,15 @@ function trailHyphen(envVar) {
|
||||
return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '');
|
||||
}
|
||||
function replaceAnyNonAlphanumericCharacter(envVar) {
|
||||
return envVar.replace(RegExp('[^a-zA-Z0-9.]', 'g'), '-');
|
||||
return envVar.replace(RegExp('[^a-zA-Z0-9._]', 'g'), '-');
|
||||
}
|
||||
function replaceAnyDotToHyphen(envVar) {
|
||||
return envVar.replace(RegExp('[.]', 'g'), '-');
|
||||
function replaceAnyNonUrlCharactersWithHyphen(envVar) {
|
||||
return envVar.replace(RegExp('[._]', 'g'), '-');
|
||||
}
|
||||
function removeRef(envVar) {
|
||||
return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '');
|
||||
}
|
||||
exports.removeRef = removeRef;
|
||||
|
||||
|
||||
/***/ }),
|
||||
|
||||
2
dist/index.js.map
vendored
2
dist/index.js.map
vendored
File diff suppressed because one or more lines are too long
23072
package-lock.json
generated
23072
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
12
package.json
12
package.json
@@ -30,10 +30,11 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@semantic-release/changelog": "^5.0.1",
|
||||
"@semantic-release/exec": "^5.0.0",
|
||||
"@semantic-release/git": "^9.0.0",
|
||||
"@types/jest": "^26.0.20",
|
||||
"@types/node": "^14.14.21",
|
||||
"@typescript-eslint/parser": "^3.9.1",
|
||||
"@typescript-eslint/eslint-plugin": "^4.22.0",
|
||||
"@vercel/ncc": "^0.23.0",
|
||||
"eslint": "^7.18.0",
|
||||
"eslint-plugin-github": "^4.1.1",
|
||||
@@ -46,12 +47,21 @@
|
||||
"ts-jest": "^26.4.4",
|
||||
"typescript": "^3.9.7"
|
||||
},
|
||||
"files": [
|
||||
"/dist"
|
||||
],
|
||||
"release": {
|
||||
"tagFormat": "${version}",
|
||||
"plugins": [
|
||||
"@semantic-release/commit-analyzer",
|
||||
"@semantic-release/release-notes-generator",
|
||||
"@semantic-release/changelog",
|
||||
[
|
||||
"@semantic-release/exec",
|
||||
{
|
||||
"prepareCmd": "git add dist"
|
||||
}
|
||||
],
|
||||
"@semantic-release/git",
|
||||
"@semantic-release/github"
|
||||
],
|
||||
|
||||
54
src/main.ts
54
src/main.ts
@@ -1,5 +1,6 @@
|
||||
import * as core from '@actions/core'
|
||||
import {
|
||||
removeRef,
|
||||
slug,
|
||||
slug_cs,
|
||||
slugref,
|
||||
@@ -31,6 +32,11 @@ const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH'
|
||||
const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART'
|
||||
const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART'
|
||||
|
||||
/**
|
||||
* New environments variables keys
|
||||
*/
|
||||
const GITHUB_REF_NAME = 'GITHUB_REF_NAME'
|
||||
|
||||
/**
|
||||
* Slugged outputs environments variables keys
|
||||
*/
|
||||
@@ -50,6 +56,8 @@ const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
|
||||
const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS'
|
||||
const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
|
||||
const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS'
|
||||
const GITHUB_REF_NAME_SLUG = 'GITHUB_REF_NAME_SLUG'
|
||||
const GITHUB_REF_NAME_SLUG_CS = 'GITHUB_REF_NAME_SLUG_CS'
|
||||
|
||||
/**
|
||||
* URL-Slugged outputs environments variables keys
|
||||
@@ -72,6 +80,8 @@ const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL'
|
||||
const GITHUB_BASE_REF_SLUG_URL_CS = 'GITHUB_BASE_REF_SLUG_URL_CS'
|
||||
const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL'
|
||||
const GITHUB_EVENT_REF_SLUG_URL_CS = 'GITHUB_EVENT_REF_SLUG_URL_CS'
|
||||
const GITHUB_REF_NAME_SLUG_URL = 'GITHUB_REF_NAME_SLUG_URL'
|
||||
const GITHUB_REF_NAME_SLUG_URL_CS = 'GITHUB_REF_NAME_SLUG_URL_CS'
|
||||
|
||||
/**
|
||||
* Shorted outputs environments variables keys
|
||||
@@ -168,6 +178,8 @@ async function run(): Promise<void> {
|
||||
exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS)
|
||||
|
||||
exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
|
||||
|
||||
exportBranchName()
|
||||
} catch (error) {
|
||||
core.setFailed(error.message)
|
||||
}
|
||||
@@ -259,17 +271,25 @@ function exportSecondPartSlug(
|
||||
function exportSlugRefCS(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slugref_cs(envVar))
|
||||
exportSlugRefCSValue(envVar, outputKey)
|
||||
}
|
||||
}
|
||||
|
||||
function exportSlugRefCSValue(envVar: string, outputKey: string): void {
|
||||
core.exportVariable(outputKey, slugref_cs(envVar))
|
||||
}
|
||||
|
||||
function exportSlugRef(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slugref(envVar))
|
||||
exportSlugRefValue(envVar, outputKey)
|
||||
}
|
||||
}
|
||||
|
||||
function exportSlugRefValue(envVar: string, outputKey: string): void {
|
||||
core.exportVariable(outputKey, slugref(envVar))
|
||||
}
|
||||
|
||||
function exportSlugUrlCS(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
@@ -334,17 +354,25 @@ function exportSecondPartSlugUrl(
|
||||
function exportSlugUrlRefCS(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slugurlref_cs(envVar))
|
||||
exportSlugUrlRefCSValue(envVar, outputKey)
|
||||
}
|
||||
}
|
||||
|
||||
function exportSlugUrlRefCSValue(envVar: string, outputKey: string): void {
|
||||
core.exportVariable(outputKey, slugurlref_cs(envVar))
|
||||
}
|
||||
|
||||
function exportSlugUrlRef(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
core.exportVariable(outputKey, slugurlref(envVar))
|
||||
exportSlugUrlRefValue(envVar, outputKey)
|
||||
}
|
||||
}
|
||||
|
||||
function exportSlugUrlRefValue(envVar: string, outputKey: string): void {
|
||||
core.exportVariable(outputKey, slugurlref(envVar))
|
||||
}
|
||||
|
||||
function exportShortSha(inputKey: string, outputKey: string): void {
|
||||
const envVar = process.env[inputKey]
|
||||
if (envVar) {
|
||||
@@ -352,4 +380,22 @@ function exportShortSha(inputKey: string, outputKey: string): void {
|
||||
}
|
||||
}
|
||||
|
||||
function exportBranchName(): void {
|
||||
//GITHUB_HEAD_REF is only set for pull request events https://docs.github.com/en/actions/reference/environment-variables
|
||||
const isPullRequest = !!process.env.GITHUB_HEAD_REF
|
||||
let refName
|
||||
if (isPullRequest) {
|
||||
refName = process.env.GITHUB_HEAD_REF
|
||||
} else {
|
||||
refName = process.env.GITHUB_REF
|
||||
}
|
||||
if (refName) {
|
||||
core.exportVariable(GITHUB_REF_NAME, removeRef(refName))
|
||||
exportSlugRefValue(refName, GITHUB_REF_NAME_SLUG)
|
||||
exportSlugRefCSValue(refName, GITHUB_REF_NAME_SLUG_CS)
|
||||
exportSlugUrlRefValue(refName, GITHUB_REF_NAME_SLUG_URL)
|
||||
exportSlugUrlRefCSValue(refName, GITHUB_REF_NAME_SLUG_URL_CS)
|
||||
}
|
||||
}
|
||||
|
||||
run()
|
||||
|
||||
@@ -111,6 +111,6 @@ function replaceAnyNonUrlCharactersWithHyphen(envVar: string): string {
|
||||
return envVar.replace(RegExp('[._]', 'g'), '-')
|
||||
}
|
||||
|
||||
function removeRef(envVar: string): string {
|
||||
export function removeRef(envVar: string): string {
|
||||
return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '')
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user