Giter VIP home page Giter VIP logo

data-platform-workflows's Introduction

Usage

Workflows

Name Description
lint.yaml Lint GitHub Actions workflows (.github/workflows/) and tox run -e lint
integration_test_charm.yaml Integration test charm
build_snap.yaml Build snap
build_rock.yaml Build rock
build_charm.yaml Build charm
release_snap.yaml Release snap to Snap Store
release_rock.yaml Release rock to GitHub Container Registry
release_charm.yaml Release charm to Charmhub
update_bundle.yaml Update charm revisions in bundle
sync_issue_to_jira.yaml Sync GitHub issues to Jira issues
_sync_docs.yaml Experimental Sync Discourse documentation to GitHub

Version

Recommendation: pin the latest version (e.g. v1.0.0) and use Renovate to stay up-to-date.

Bug fixes will not be backported.

Example workflow:

jobs:
  build:
    name: Build charms
    uses: canonical/data-platform-workflows/.github/workflows/[email protected]

Example Renovate configuration:

{
  "enabledManagers": ["poetry", "github-actions"],
  "packageRules": [
    // Later rules override earlier rules

    // Group data-platform-workflows Python package & workflow updates into the same PR
    {
      "matchManagers": ["poetry"],
      "matchPackageNames": ["canonical/data-platform-workflows"],
      // Workaround for https://github.com/renovatebot/renovate/discussions/23628
      "versioning": "semver",
      "groupName": "data-platform-workflows",
      // Workaround: data-platform-workflows Python packages use git tags instead of pyproject.toml
      // for versioning. Therefore, Renovate will always think an update is a major version update.
      "separateMajorMinor": false
    },
    {
      "matchManagers": ["github-actions"],
      "matchPackageNames": ["canonical/data-platform-workflows"],
      "groupName": "data-platform-workflows",
      // Workaround: data-platform-workflows Python packages use git tags instead of pyproject.toml
      // for versioning. Therefore, Renovate will always think an update is a major version update.
      // Since we want packages to be updated alongside workflows (actions), we must disable
      // separate major PRs for workflows as well.
      "separateMajorMinor": false
    }
  ]
}

Note: all workflows in this repository share a version number. If a breaking change is made to the public interface of one workflow, all workflows will have a new major version even if they have no breaking changes.

If you do not want to use Renovate, pin to the latest major version (e.g. v1).

Public interface

Workflows that do not begin with an underscore (e.g. foo.yaml) may be called outside this repository.

Workflows that begin with one underscore (e.g. _foo.yaml) are internal and are only intended to be called by reusable workflows in this repository (that begin with zero or one underscores).

Workflows that begin with two underscores (e.g. __foo.yaml) are for this repository only. They may only be (triggered by an event on this repository or) called by workflows in this repository that begin with two underscores.

Contributing

See CONTRIBUTING.md

data-platform-workflows's People

Contributors

carlcsaposs-canonical avatar a-velasco avatar dragomirp avatar mehdi-bendriss avatar phvalguima 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.