Code Monkey home page Code Monkey logo

boost's Introduction

boost mirror

A boost.org release mirror using Github workflows and the release system. This example repo has bootstrapped the source and binary folders of the remote with the exception rc or non release assets.

Note

This solution aims to be an easy reproducible release mirror so if it's not a release asset we are not interested in it. alpha,beta and rc candidates are not releases.

How it works

There are 2 pairs of workflows that achieve different goals for a mirror repository. Pairs are linked as source or source and binary

bootstrap_source.yml (pair 1)
bootstrap_source_binary.yml (pair 2)
check_new_release_source.yml (pair 1)
check_new_release_source_binary.yml (pair 2)

Important

The workflows source will only get a specific set of boost release source code archives from the remote source folders. If you need a header only or source only mirror.

Tip

This is what most projects will be using. The packaged source archives with the headers or used to build the components they need.

Note

The source workflows work with just the github.token and need no special permissions in a newly forked repo It takes just over 60 seconds to bootstrap the releases.

Important

The workflows source and binary will get all files except alpha,beta and rc files from the remote source and binary folders.

Caution

The source and binary workflows will not work with just the github.token and need a PAT created with minimal permissions to overcome api rate limiting. It takes just around 5 minutes to bootstrap this and involves some large files.

In the repository settings, create a repository secret, called BOOST, with the token created. The workflows are already prepped to use this ${{ secrets.BOOST }}

Finally, you have the corresponding automated check release workflows which will create new releases in the same format as the selected bootstrap workflow.

After a repo is bootstrapped we focus on the new releases and will never use that workflow again so it is required to be manually triggered.

Summary

In Summary, to bootstrap a source only repo:

  1. The bootstrap_source.yml will determine the latest release and create an array of versions from 1.63.0, the earliest version hosted on either boostorg.jfrog.io or archives.boost.io, through to current the latest version.
  2. This will fire a matrix job using that array and download the main assets and upload them as tagged releases, using a tag version that matches the https://github.com/boostorg/boost/tags format.
  3. Remote latest release tag will be set as the local latest release tag.
  4. A scheduled check_new_release_source.yml will check for new releases and mirror them as they are released.

Note

Source location redundancy starting with boostorg.jfrog.io falling back to archives.boost.io

So just fork the repo, run the boost bootstrap.yml

Then edit the paired check release workflow to enable the scheduler.

You now have mirror that will update itself when new releases are available.

Need to know

Warning

The scheduled part of the workflows is commented out until you decide which one to use.

 # schedule:
 #   - cron: "*/30 */1 * * *"

Credits

Dynamic matrix arrays: https://www.kenmuse.com/blog/dynamic-build-matrices-in-github-actions/

boost's People

Contributors

userdocs avatar

Stargazers

Ben avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.