Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/conormacbride/gh-serve

Serve GitHub Actions HTML artifacts locally 🌍

https://github.com/conormacbride/gh-serve

Science Score: 13.0%

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

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

Keywords

artifact ci gh-extension github github-actions go golang html web
Last synced: 5 months ago · JSON representation

Repository

Serve GitHub Actions HTML artifacts locally 🌍

Basic Info
  • Host: GitHub
  • Owner: ConorMacBride
  • License: mit
  • Language: Go
  • Default Branch: main
  • Homepage:
  • Size: 8.79 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
artifact ci gh-extension github github-actions go golang html web
Created almost 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License

README.md

gh-serve

Serve GitHub Actions HTML artifacts locally 🌍

gh-serve is a GitHub CLI extension that finds GitHub Actions artifacts for the current PR, or branch, and serves them on a local web server. This allows you to quickly preview HTML artifacts, such as CI test reports or documentation websites.

Installation

gh extension install ConorMacBride/gh-serve

Upgrade:

gh extension upgrade gh-serve

Usage

Navigate to a GitHub repository, and run:

gh serve

It will find artifacts for GitHub Actions workflow runs for the latest commit to the current open PR, or branch. If there are multiple artifacts, an interactive menu will appear, allowing you to select the one to serve. The artifact will be hosted at http://localhost:8080/.

Available flags:

text --no-browser don't open the artifact in your default browser --no-cache don't use cached artifacts --port string port to serve the artifact on (default "8080") -h, --help show help for command

How it works

  1. 🔎 Finds GitHub Actions workflow runs for the current PR, or branch
    • Only finds runs for the latest remote commit
    • If the current branch has an open PR, prefer pull_request events
  2. 📝 Lists all the artifacts for the workflow runs
    • Interactively select the artifact to serve, if there are multiple
  3. 💾 Downloads the artifact
    • Caches in <repo-root>/.cache/gh-serve/<run-id>/<artifact-name>/
    • Ignore cache with --no-cache
  4. 🌍 Serves the artifact on a local web server
    • Default port is 8080
    • Change port with --port <port>
  5. 👀 Opens the artifact in your default browser
    • Skip with --no-browser

Owner

  • Name: Conor MacBride
  • Login: ConorMacBride
  • Kind: user
  • Location: Derry, Northern Ireland

Data Scientist · Astrophysics PhD

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 2
proxy.golang.org: github.com/ConorMacBride/gh-serve
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.8%
Average: 6.0%
Dependent repos count: 6.2%
Last synced: 6 months ago
proxy.golang.org: github.com/conormacbride/gh-serve
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 9.1%
Average: 9.7%
Dependent repos count: 10.3%
Last synced: 6 months ago