Giter VIP home page Giter VIP logo

compathelper.jl's Introduction

CompatHelper.jl

CompatHelper.jl is a Julia package which keeps your Project.toml [compat] entries up to date.

Category Status
Unit Tests Continuous Integration (Unit Tests)
Integration Tests Continuous Integration (Integration Tests)
Documentation Documentation
Code Coverage Code Coverage
Style Guide Style Guide

Setup

GitHub

Create a file at .github/workflows/CompatHelper.yml with the contents of the CompatHelper.yml that is included in this repository.

If you need to use any special arguments for the main function, you can modify this file to add them.

GitLab

For GitLab you will want to add CompatHelper as a job in your .gitlab-ci.yml file such as:

CompatHelper:
  image: julia:1.6 # Set to the Julia version you want to use
  stage: compat # You can place this in any stage that makes sense for your setup
  before_script:
    - apt-get update -qq && apt-get install -y git
    - |
      julia --color=yes -e "
        import Pkg;
        ENV[\"JULIA_PKG_SERVER\"] = \"\";
        Pkg.Registry.add(\"General\");"
    - |
      julia --color=yes -e "
        import Pkg;
        name = \"CompatHelper\";
        uuid = \"aa819f21-2bde-4658-8897-bab36330d9b7\";
        version = \"3\";
        Pkg.add(; name, uuid, version)"
  script:
    - |
      julia --color=yes -e "
        import CompatHelper;
        CompatHelper.main()"

Similarly to the GitHub setup, you can modify the main call here if you need to change any of the default arguments. You must also remember to add the GITLAB_TOKEN and COMPATHELPER_PRIV CI secrets to the project so that CompatHelper can find them.

Environment Variables

GitHub & GitLab

Name Description
GIT_COMMITTER_NAME Name to associate commits with [Default: CompatHelper Julia]
GIT_COMMITTER_EMAIL Email to associate commits with [Default: [email protected]]
COMPATHELPER_PRIV Plain Text or Base64 Encoded SSH Public Key for git pushes and API calls

GitHub

Name Description
GITHUB_TOKEN GitHub Access Token, user for GitHub API Requests, provided by default on GitHub Actions
GITHUB_REPOSITORY Name on GitHub of the organization/repo, provided by default on GitHub
GITHUB_ACTOR GitHub Username that triggered the Action, provided by default by GitHub Actions. This is used to CC the user on the pull request if enabled

GitLab

Name Description
GITLAB_TOKEN GitLab Access Token, used for GitLab API Requests
CI_PROJECT_PATH Name on GitLab of the organization/repo, provided by default on GitLab
GITLAB_USER_LOGIN GitLab Username that triggered the Pipeline, provided by defalt by GitLab CI. This is used to CC the user on pull request if enabled

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.