toolchain icon indicating copy to clipboard operation
toolchain copied to clipboard

Add instructions for maintaining repo

Open Eeems opened this issue 2 years ago • 4 comments

It would be useful to have instructions for the expected workflow of this repo.

  • How to update an image
  • How to create a new version of images
  • How to add a new image
  • etc

Eeems avatar Jun 08 '23 17:06 Eeems

What I've discovered so far:

  • v1.x and v2.x branches are where the work is actually done
  • PRs from forks fail to build until they've been merged. Use branches on this repo until this can be fixed, I guess.
  • Merging a PR will update the latest tag, but not create new tags
  • Creating a new GitHub release will create a new image tag as well

Eeems avatar Jun 08 '23 17:06 Eeems

It looks like new images are published as a new package, but it's private by default and needs to be changed to public.

Eeems avatar Jun 24 '23 23:06 Eeems

You will also need to update CHANGELOG.md in the main branch when a new release tag has been created.

Eeems avatar Jul 25 '23 08:07 Eeems

Creating a new v#.x branch requires updating the readme in the main branch with the latest information.

Eeems avatar Jul 25 '23 08:07 Eeems