Skip to content
This repository was archived by the owner on Apr 17, 2023. It is now read-only.
This repository was archived by the owner on Apr 17, 2023. It is now read-only.

Narrative: Draft a walkthrough of using modulesync to maintain PCT scaffolded content #337

@michaeltlombardi

Description

@michaeltlombardi

As a puppet content maintainer, I want a coherent way to maintain content across my repos without having to manually make changes for every piece of content in every repo so that I can have a consistent code base with best/latest design values and functionality.

Acceptance Criteria

New narrative document to walkthrough using modulesync with PCT scaffolded content which covers:

  • What is modulesync (high level)
  • How to add modulesync config to a repository
  • How to perform a sync
  • Links to further documentation

Discussed in #293

Originally posted by cdenneen November 8, 2021
There needs to be a way to keep modules, control repositories, etc in sync with a template.

At some point people will create "artifacts" from these PCT's but as things evolve the goal will be to update the "upstream" template and then have the "artifacts" sync back those updates, if they choose.

This comes with some challenges in this current model:

  • If there is a complete template you are syncing from this might be easier but still needs to be doable.
  • If you created the components from different templates (public, private, etc) this needs to be tracked I would guess in some sort of pdk/pct configuration to allow to "update"/"sync" from their individual upstream sources.
    - So you could have now created a custom template (or repo, or module) that is a combination of different upstream sources. You might want to keep those in sync. Base template, maybe a gitlab-ci template, GH Actions template, etc.

You could have pct update all that goes through all the upstream pieces and creates an update_report.txt.
You could do pct update puppetlabs/editorconfig.
You could do combination of pct update puppetlabs/puppet-control-repo, pct update puppetlabs/editorconfig, pct update thirdparty/puppet-fact factname, pct update thirdparty/bolt-plan planname.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions