Data

Tools

Indexes

Applications

Experiments

Open Source Science

setup-powershell-toolkit-ghaction

A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit`.

https://github.com/hugoalh/setup-powershell-toolkit-ghaction

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

gh-action ghaction github-action powershell setup
Last synced: 4 months ago · JSON representation ·

Repository

A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit`.

Basic Info
  • Host: GitHub
  • Owner: hugoalh
  • License: other
  • Language: PowerShell
  • Default Branch: main
  • Homepage:
  • Size: 115 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 15
Topics
gh-action ghaction github-action powershell setup
Created almost 3 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners Security

README.md

Setup PowerShell Toolkit (GitHub Action)

⚖️ MIT

GitHub: hugoalh/setup-powershell-toolkit

A GitHub Action to setup PowerShell module hugoalh.GitHubActionsToolkit (GitHub)(PowerShell Gallery).

[!IMPORTANT] This documentation is v2.0.0 based; To view other version's documentation, please visit the versions list and select the correct version.

🎯 Target

  • GitHub Actions Runner > 🛡️ Require Permission > > N/A

💽 Require Software

  • PowerShell >= v7.2.0

🔰 Usage

Composite Action

  1. Import at the metadata (action.yml): yml runs: using: "composite" steps: - uses: "hugoalh/setup-powershell-toolkit-ghaction@<Tag>"

Workflow

  1. Import at the workflow (.github/workflows/<WorkflowName>.yml): yml jobs: job_id: runs-on: "________" # Any steps: - uses: "hugoalh/setup-powershell-toolkit-ghaction@<Tag>"

🧩 Input

[!NOTE] All of the inputs are optional; Use this action without any input will default to install major equitant latest version of 2.1.0 for current user, and keep the setting that modified.

sudo

<Boolean = False> Whether to execute in sudo mode on non-Windows environment. This must set to True in order to able install for all users on non-Windows environment (i.e.: when input scope is "AllUsers").

version

<String = "^2.1.0"> Target version, by Semantic Versioning (SemVer) 2.0.0 with optional modifier; Default to major equitant latest version of 2.1.0.

  • "Latest": Latest version
  • "<1.2.3": Less than this version
  • "<=1.2.3": Less than or equal to this version
  • "1.2.3" / "=1.2.3": Equal to this version
  • ">=1.2.3": Greater than or equal to this version
  • ">1.2.3": Greater than this version
  • "^1.2.3": Between this version and major equitant latest version
  • "~1.2.3": Between this version and minor equitant latest version

allowprerelease

<Boolean = False> Whether to allow target pre release version.

scope

<String = "CurrentUser"> Installation scope.

  • "AllUsers": For all users. Also need to set input sudo to True on non-Windows environment.
  • "CurrentUser": For current user.

force

<Boolean = False> Whether to force install or reinstall target (pre release) version.

keepsetting

<Boolean = False> Whether to keep the setting that modified.

🧩 Output

path

<String> Path of the installation.

version

<SemVer> Version of the installation.

✍️ Example

  • yml jobs: job_id: name: "Hello World" runs-on: "ubuntu-latest" steps: - name: "Setup PowerShell Toolkit" uses: "hugoalh/setup-powershell-toolkit-ghaction@v2.0.0" - run: | Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local' Write-GitHubActionsNotice -Message 'Hello, world!' shell: "pwsh"

📚 Guide

Owner

  • Name: hugoalh
  • Login: hugoalh
  • Kind: user
  • Location: Everywhere
  • Company: @hugoalh-studio

Lead of @hugoalh-studio; Full time software developer; Part time freelancer

Citation (CITATION.cff) 

# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
cff-version: "1.2.0"
title: "Setup PowerShell Toolkit (GitHub Action)"
message: "If you use this software, please cite it using the metadata from this file."
type: "software"
authors:
  - name: "hugoalh"
repository-code: "https://github.com/hugoalh/setup-powershell-toolkit-ghaction"
keywords:
  - "gh-action"
  - "ghaction"
  - "github-action"
  - "powershell"
  - "setup"
  - "toolkit"
license: "MIT"

GitHub Events

Total
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 4
  • Create event: 2
Last Year
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 4
  • Create event: 2

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 0
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 4
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (4)
Top Labels
Issue Labels
Pull Request Labels
Platform/GitHubActions (4) Status/Pending 🔵 (4) Type/Dependency 📦 (4)

Dependencies

.github/workflows/announce-new-release-discord.yml actions
.github/workflows/scan-virus.yml actions
.github/workflows/sync-labels.yml actions
.github/workflows/test.yml actions
  • hugoalh-studio/setup-powershell-toolkit-ghaction main composite
action.yml actions