Document current SIMP CI/CD/RELENG process and procedures

Description

There have been many changes within SIMP's CI/CD/RELENG processes in the last few months.

It is now complex and codified enough that contributors should have documentation to better understand and maintain it.

Among the topics that should be covered:

  • RELENG automation

  • Travis CI pipelines ( )

    • ENV variables

    • Common use cases

    • Updating (puppetsync)

  • GitLab CI pipelines

    • ENV variables

    • Updating (puppetsync)

    • Scheduled jobs

    • Common use cases

  • Common Asset Syncs (puppetsync)

    • What is managed and why

    • How to manage a comment asset push

    • Guidelines (what to manage or not, how to handle approvals, testing)

    • Common use cases

    • Updating (puppetsync)

  • Maintaining Repo-specific assets

    • Gemfile (puppetsync-only) vs Gemfile.project (repo-only) vs Gemfile.local (user-only)

    • .gitlab-ci.yml "safe zone" for repo-specific content

    • Rake tasks (rake ci:lint, etc.,)

  • RELENG misc topics

    • GitHub CI maintenance

      • Querying/Setting required PR checks

      • Maintenance tools

    • GitLab CI maintenance

      • Mirroring and GitHub PR check integration

      • Maintenance tools

Acceptance Criteria

None

Story Points

None

Components

Affects versions

Priority

High

Epic Name

DOCUMENT CI/CD/RELENG