Skip to content

cloudposse-github-actions/install-gh-releases

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace
Β 
Β 

Project Banner

Latest ReleaseSlack Community

Install the Github Release binaries


Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

We have dozens of GitHub Actions that are Open Source and well-maintained. Check them out!

Introduction

Fork of jaxxstorm/action-install-gh-release modified to install multiple releases at once and adopted to Cloud Posse's GitHub Actions standards.

Define set of GH releases to install as config input following the format:

  • Short format:

      acme/repo-1: latest

    or

      acme/repo-1:

    which are equivalent

  • Long format:

    acme/repo-4:
      tag: v0.1.0
      platform: linux
      arch: amd64
      ## Seek for `(tar.gz|zip|tgz)` archived asset (default "extension")
      extension-matching: true

Long format supports the following parameters:

Name Description Default
skip Set true to skip this release false
tag Tag containing binary to install latest
platform OS Platform to match in release package {platform of current runner}
arch OS Architecture to match in release package {arch of current runner}
extension-matching Set true to match extension in release package false
extension Extension match pattern tar.gz|zip|tgz
rename-to When installing a release that is not an archive, e.g. a pure binary, this controls how the downloaded release asset is renamed. null
chmod When installing a release that is not an archive, e.g. a pure binary, this controls how the downloaded release asset is chmod'd. null

Usage

Important

In Cloud Posse's examples, we avoid pinning GitHub Actions to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each GitHub Action to the exact version you're using. This practice ensures the stability of your workflows. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

  on:
    push:
      branches:
        - main

  jobs:
    install:
      name: Install depenedencies
      runs-on: ubuntu-latest
      steps:
        - uses: cloudposse-github-actions/install-gh-releases@main
          with:
            cache: true
            config: |-
              jaxxstorm/change-aws-credentials: v0.4.0
              pulumi/crd2pulumi: latest
              jaxxstorm/connecti:
              mozilla/grcov:
                tag: v0.8.7
                platform: linux
                arch: amd64
                extension: "\\.bz2"
                extension-matching: true
              open-telemetry/opentelemetry-collector:
                tag: v0.62.1
                platform: linux
                arch: amd64
                extension-matching: false
                rename-to: ocb
                chmod: 755
              prometheus/prometheus:
                tag: "v2.37.9"
                platform: linux
                arch: amd64
                extension-matching: false
                binaries-location: "prometheus-2.37.9.linux-amd64"
              aquasecurity/tfsec:
                skip: true
                tag: v1.19.0
                platform: linux
                arch: amd64
                extension-matching: true

Inputs

Name Description Default Required
cache When set to 'true', caches the releases of known tags with actions/cache false false
config Releases configuration to install (YAML format) N/A true
token GITHUB_TOKEN or a repo scoped Personal Access Token (PAT) ${{ github.token }} false

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

πŸ› Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

πŸ’» Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and GitHub Action insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by Cloud Posse, LLC.

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS & GitHub Actions to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Learn More

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

πŸ“š See What's Included
  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Copyright Β© 2017-2024 Cloud Posse, LLC

README footer

Beacon

About

Install executable binaries from Github Releases

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages

  • TypeScript 97.4%
  • Makefile 1.6%
  • JavaScript 1.0%