Add instructions for maintaining repo

toltec-dev / toolchain

Set of Docker images for cross-compiling binaries targeting the reMarkable tablet.

MIT License

34 stars 12 forks source link

Open Eeems opened 1 year ago

Eeems commented 1 year ago

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

Eeems commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

Eeems commented 1 year ago

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